diff --git a/README.md b/README.md index bac4151..f7e14f7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Beyond API Ruby Client +# Beyond Api Ruby Client Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/beyond_api`. To experiment with that code, run `bin/console` for an interactive prompt. diff --git a/beyond_api.gemspec b/beyond_api.gemspec index 7f3d8ec..6de6158 100644 --- a/beyond_api.gemspec +++ b/beyond_api.gemspec @@ -5,10 +5,10 @@ require "beyond_api/version" Gem::Specification.new do |spec| spec.name = "beyond_api" - spec.version = BeyondAPI::VERSION + spec.version = BeyondApi::VERSION spec.authors = ["Unai Abrisketa", "German San Emeterio", "Kathia Salazar"] - spec.summary = %q{Ruby client to access the Beyond API} + spec.summary = %q{Ruby client to access the Beyond Api} # spec.description = %q{Write a longer description or delete this line.} spec.homepage = "https://github.com/ePages-de/beyond_api" diff --git a/bin/console b/bin/console index 390ed35..cf6ca57 100755 --- a/bin/console +++ b/bin/console @@ -5,7 +5,7 @@ require "dotenv/load" require "beyond_api" unless ENV["CLIENT_ID"].nil? and ENV["CLIENT_SECRET"].nil? - BeyondAPI.setup do |config| + BeyondApi.setup do |config| config.client_id = ENV["CLIENT_ID"] config.client_secret = ENV["CLIENT_SECRET"] config.remove_response_links = true diff --git a/endpoints.md b/endpoints.md index 1b28936..62b6aa1 100644 --- a/endpoints.md +++ b/endpoints.md @@ -4,7 +4,7 @@ ✅ = Checked -🌞 = On the Ruby API +🌞 = On the Ruby Api ## 1. Change Log @@ -1165,7 +1165,7 @@ session.products.disable_purchasability(product_id) ## 17. Custom Product Attributes -The `attributes` resource is used to manage additional user-defined attributes which have a product attribute definition as key, and a string or number as value. These are the basic attribute types supported by the API. +The `attributes` resource is used to manage additional user-defined attributes which have a product attribute definition as key, and a string or number as value. These are the basic attribute types supported by the Api. | Type | Description | |---|---| @@ -1939,7 +1939,7 @@ session.newsletter_target.delete ## 27. Webhooks -This resource is used to manage webhook subscriptions. ePages can send webhook notifications to your application any time an event happens that you’ve subscribed to. Subscriptions are useful for events that are not triggered by a direct API request. The following event types are supported: +This resource is used to manage webhook subscriptions. ePages can send webhook notifications to your application any time an event happens that you’ve subscribed to. Subscriptions are useful for events that are not triggered by a direct Api request. The following event types are supported: | Event Type Name | Description | Required Scope | |---|---|---| diff --git a/lib/beyond_api.rb b/lib/beyond_api.rb index 536da19..a861ef2 100644 --- a/lib/beyond_api.rb +++ b/lib/beyond_api.rb @@ -7,7 +7,7 @@ require "beyond_api/ext" require "beyond_api/utils" -module BeyondAPI +module BeyondApi class Error < StandardError; end class << self diff --git a/lib/beyond_api/connection.rb b/lib/beyond_api/connection.rb index 115258e..3d54009 100644 --- a/lib/beyond_api/connection.rb +++ b/lib/beyond_api/connection.rb @@ -2,12 +2,12 @@ require 'faraday' -module BeyondAPI +module BeyondApi class Connection def self.default Faraday.new(ssl: { verify: true }) do |faraday| - faraday.options[:open_timeout] = BeyondAPI.configuration.open_timeout.to_i - faraday.options[:timeout] = BeyondAPI.configuration.timeout.to_i + faraday.options[:open_timeout] = BeyondApi.configuration.open_timeout.to_i + faraday.options[:timeout] = BeyondApi.configuration.timeout.to_i faraday.headers['Accept'] = 'application/json' faraday.headers['Content-Type'] = 'application/json' faraday.request(:multipart) @@ -18,12 +18,12 @@ def self.default def self.token Faraday.new(ssl: { verify: true }) do |faraday| - faraday.options[:open_timeout] = BeyondAPI.configuration.open_timeout.to_i - faraday.options[:timeout] = BeyondAPI.configuration.timeout.to_i + faraday.options[:open_timeout] = BeyondApi.configuration.open_timeout.to_i + faraday.options[:timeout] = BeyondApi.configuration.timeout.to_i faraday.headers['Accept'] = 'application/json' faraday.adapter(:net_http) - faraday.basic_auth(BeyondAPI.configuration.client_id, - BeyondAPI.configuration.client_secret) + faraday.basic_auth(BeyondApi.configuration.client_id, + BeyondApi.configuration.client_secret) end end end diff --git a/lib/beyond_api/request.rb b/lib/beyond_api/request.rb index bf83ba9..a45f5a6 100644 --- a/lib/beyond_api/request.rb +++ b/lib/beyond_api/request.rb @@ -2,12 +2,12 @@ require "json" -module BeyondAPI +module BeyondApi class Request class << self [:get, :delete].each do |method| define_method(method) do |session, path, params = {}| - response = BeyondAPI::Connection.default.send(method) do |request| + response = BeyondApi::Connection.default.send(method) do |request| request.url(session.api_url + path) request.headers['Authorization'] = "Bearer #{ session.access_token }" request.params = params.to_h.camelize_keys @@ -19,7 +19,7 @@ class << self [:post, :put, :patch].each do |method| define_method(method) do |session, path, body = {}, params = {}| - response = BeyondAPI::Connection.default.send(method) do |request| + response = BeyondApi::Connection.default.send(method) do |request| request.url(session.api_url + path) request.headers['Authorization'] = "Bearer #{ session.access_token }" request.params = params.to_h.camelize_keys @@ -32,7 +32,7 @@ class << self end def self.upload(session, path, file_binary, content_type, params) - response = BeyondAPI::Connection.default.post do |request| + response = BeyondApi::Connection.default.post do |request| request.url(session.api_url + path) request.headers['Authorization'] = "Bearer #{ session.access_token }" request.headers['Content-Type'] = content_type @@ -44,7 +44,7 @@ def self.upload(session, path, file_binary, content_type, params) end def self.token(url, params) - response = BeyondAPI::Connection.token.post do |request| + response = BeyondApi::Connection.token.post do |request| request.url(url) request.params = params end diff --git a/lib/beyond_api/resources/base.rb b/lib/beyond_api/resources/base.rb index 35b3a8e..b3e40e2 100644 --- a/lib/beyond_api/resources/base.rb +++ b/lib/beyond_api/resources/base.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module BeyondAPI +module BeyondApi class Base class InvalidSessionError < StandardError; end @@ -8,7 +8,7 @@ class InvalidSessionError < StandardError; end def initialize(session) @session = session - raise InvalidSessionError.new("Invalid session") unless session.is_a? BeyondAPI::Session + raise InvalidSessionError.new("Invalid session") unless session.is_a? BeyondApi::Session if session.api_url.nil? || session.access_token.nil? || session.refresh_token.nil? raise InvalidSessionError.new("Session api_url, access_token and refresh_token cannot be nil") end diff --git a/lib/beyond_api/resources/carts.rb b/lib/beyond_api/resources/carts.rb index fc5c3e1..ad026eb 100644 --- a/lib/beyond_api/resources/carts.rb +++ b/lib/beyond_api/resources/carts.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class Carts < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +POST+ request is used to add a line item to the cart. Currently only product line items are supported. @@ -27,7 +27,7 @@ class Carts < Base # @cart = session.carts.add_line_item("6d529573-b39e-4cd4-99fe-856432ea97f3", body) # def add_line_item(cart_id, body) - response, status = BeyondAPI::Request.post(@session, "/carts/#{cart_id}/line-items", body) + response, status = BeyondApi::Request.post(@session, "/carts/#{cart_id}/line-items", body) handle_response(response, status) end @@ -44,7 +44,7 @@ def add_line_item(cart_id, body) # @cart = session.carts.create # def create(body) - response, status = BeyondAPI::Request.post(@session, "/carts", body) + response, status = BeyondApi::Request.post(@session, "/carts", body) handle_response(response, status) end @@ -73,7 +73,7 @@ def create(body) # @payment = session.carts.create_payment("158bdcee-178a-4b5f-88ff-1953f5ea8e09/", body) # def create_payment(cart_id, body) - response, status = BeyondAPI::Request.post(@session, "/carts/#{cart_id}/create-payment", body) + response, status = BeyondApi::Request.post(@session, "/carts/#{cart_id}/create-payment", body) handle_response(response, status) end @@ -114,7 +114,7 @@ def create_payment(cart_id, body) # @payment = session.carts.create_payment_and_order("f6c6615b-a9f6-420e-be1d-46339ddc5fda", body) # def create_payment_and_order(cart_id, body) - response, status = BeyondAPI::Request.post(@session, "/carts/#{cart_id}/create-payment-and-order", body) + response, status = BeyondApi::Request.post(@session, "/carts/#{cart_id}/create-payment-and-order", body) handle_response(response, status) end @@ -149,7 +149,7 @@ def create_payment_and_order(cart_id, body) # @order = session.carts.create_order("986247da-b78f-422c-a273-917804896974", body) # def create_order(cart_id, body) - response, status = BeyondAPI::Request.post(@session, "/carts/#{cart_id}/order", body) + response, status = BeyondApi::Request.post(@session, "/carts/#{cart_id}/order", body) handle_response(response, status) end @@ -167,7 +167,7 @@ def create_order(cart_id, body) # session.carts.delete("1a58f22f-481a-4993-9947-62c1c2857f87") # def delete(cart_id) - response, status = BeyondAPI::Request.delete(@session, "/carts/#{cart_id}") + response, status = BeyondApi::Request.delete(@session, "/carts/#{cart_id}") handle_response(response, status, respond_with_true: true) end @@ -186,7 +186,7 @@ def delete(cart_id) # @cart = session.carts.delete_line_item("3fb55475-f6d2-471a-90ac-ccee7896b9f7", "51c86195-d2b9-4073-9a14-7ddd5a76b6a7") # def delete_line_item(cart_id, line_item_id) - response, status = BeyondAPI::Request.delete(@session, "/carts/#{cart_id}/line-items/#{line_item_id}") + response, status = BeyondApi::Request.delete(@session, "/carts/#{cart_id}/line-items/#{line_item_id}") handle_response(response, status, respond_with_true: true) end @@ -205,7 +205,7 @@ def delete_line_item(cart_id, line_item_id) # session.carts.delete_line_item("2fa7dc36-8305-4628-b961-f2c3f7dda47d") # def delete_shipping_address(cart_id) - response, status = BeyondAPI::Request.delete(@session, "/carts/#{cart_id}/shipping-address") + response, status = BeyondApi::Request.delete(@session, "/carts/#{cart_id}/shipping-address") handle_response(response, status, respond_with_true: true) end @@ -225,7 +225,7 @@ def delete_shipping_address(cart_id) # @cart = session.carts.find("26857145-aeab-4210-9191-3906573a14ae") # def find(cart_id) - response, status = BeyondAPI::Request.get(@session, "/carts/#{cart_id}") + response, status = BeyondApi::Request.get(@session, "/carts/#{cart_id}") handle_response(response, status) end @@ -244,7 +244,7 @@ def find(cart_id) # @payment_method = session.carts.payment_method("26857145-aeab-4210-9191-3906573a14ae") # def payment_method(cart_id) - response, status = BeyondAPI::Request.get(@session, "/carts/#{cart_id}/payment-methods/current") + response, status = BeyondApi::Request.get(@session, "/carts/#{cart_id}/payment-methods/current") handle_response(response, status) end @@ -266,7 +266,7 @@ def payment_method(cart_id) # @payment_methods = session.carts.payment_methods("45f9009d-4d2f-43b1-9cd2-ea29ff0d46d6") # def payment_methods(cart_id) - response, status = BeyondAPI::Request.get(@session, "/carts/#{cart_id}/payment-methods") + response, status = BeyondApi::Request.get(@session, "/carts/#{cart_id}/payment-methods") handle_response(response, status) end @@ -293,7 +293,7 @@ def payment_methods(cart_id) # @cart = session.carts.replace_line_item("f73629e5-fecf-4474-9b04-6b2fcd4663c4", "2c9c0f38-0b9e-4fa7-bcbe-960098ff63aa", body) # def replace_line_item(cart_id, line_item_id, body) - response, status = BeyondAPI::Request.put(@session, "/carts/#{cart_id}/line-items/#{line_item_id}", body) + response, status = BeyondApi::Request.put(@session, "/carts/#{cart_id}/line-items/#{line_item_id}", body) handle_response(response, status) end @@ -315,7 +315,7 @@ def replace_line_item(cart_id, line_item_id, body) # @cart = session.carts.replace_line_item("c1436110-e283-49b3-a748-0321efec6d35", body) # def replace_line_items(cart_id, body) - response, status = BeyondAPI::Request.put(@session, "/carts/#{cart_id}/line-items", body) + response, status = BeyondApi::Request.put(@session, "/carts/#{cart_id}/line-items", body) handle_response(response, status) end @@ -364,7 +364,7 @@ def replace_line_items(cart_id, body) # @cart = session.carts.set_billing_address("01da6aa7-8aa2-4383-a496-6611a14afbc9", body) # def set_billing_address(cart_id, body) - response, status = BeyondAPI::Request.put(@session, "/carts/#{cart_id}/billing-address", body) + response, status = BeyondApi::Request.put(@session, "/carts/#{cart_id}/billing-address", body) handle_response(response, status) end @@ -386,7 +386,7 @@ def set_billing_address(cart_id, body) # @cart = session.carts.set_payment_method("750c8a68-ef58-4955-b05f-29e35fa19687", "6498f339-7fe6-43d4-8e2a-6da68d7cdfe3") # def set_payment_method(cart_id, payment_method_id) - response, status = BeyondAPI::Request.put(@session, "/carts/#{cart_id}/payment-methods/current", + response, status = BeyondApi::Request.put(@session, "/carts/#{cart_id}/payment-methods/current", "#{@session.api_url}/payment-methods/#{payment_method_id}") handle_response(response, status) @@ -407,7 +407,7 @@ def set_payment_method(cart_id, payment_method_id) # @cart = session.carts.set_payment_method_to_default("d1efcb74-ab96-43c5-b404-9c1f927dc3d2") # def set_payment_method_to_default(cart_id) - response, status = BeyondAPI::Request.put(@session, "/carts/#{cart_id}/payment-methods/default") + response, status = BeyondApi::Request.put(@session, "/carts/#{cart_id}/payment-methods/default") handle_response(response, status) end @@ -456,7 +456,7 @@ def set_payment_method_to_default(cart_id) # @cart = session.carts.set_shipping_address("01da6aa7-8aa2-4383-a496-6611a14afbc9", body) # def set_shipping_address(cart_id, body) - response, status = BeyondAPI::Request.put(@session, "/carts/#{cart_id}/shipping-address", body) + response, status = BeyondApi::Request.put(@session, "/carts/#{cart_id}/shipping-address", body) handle_response(response, status) end @@ -479,7 +479,7 @@ def set_shipping_address(cart_id, body) # @cart = session.carts.set_shipping_method("a4e7922a-f895-4a7d-8cb1-6ecf74d7ceba", "59e26c99-ef1d-4ee8-a79f-d078cd6dfe24", "f3d3ce8d-eeab-44b6-81bb-67a4f1d7a57f") # def set_shipping_method(cart_id, shipping_zone_id, shipping_method_id) - response, status = BeyondAPI::Request.put(@session, "/carts/#{cart_id}/shipping-methods/current", + response, status = BeyondApi::Request.put(@session, "/carts/#{cart_id}/shipping-methods/current", "#{session.api_url}/shipping-zones/#{shipping_zone_id}/shipping-methods/#{shipping_method_id}") handle_response(response, status) @@ -501,7 +501,7 @@ def set_shipping_method(cart_id, shipping_zone_id, shipping_method_id) # @cart = session.carts.set_shipping_method_to_default("a4e7922a-f895-4a7d-8cb1-6ecf74d7ceba") # def set_shipping_method_to_default(cart_id) - response, status = BeyondAPI::Request.put(@session, "/carts/#{cart_id}/shipping-methods/current", + response, status = BeyondApi::Request.put(@session, "/carts/#{cart_id}/shipping-methods/current", "#{session.api_url}/shipping-zones/#{shipping_zone_id}/shipping-methods/#{shipping_method_id}") handle_response(response, status) @@ -522,7 +522,7 @@ def set_shipping_method_to_default(cart_id) # @shipping_method = session.carts.shipping_method("9093a339-66fd-4cc1-9dcf-d23003c38b41") # def shipping_method(cart_id) - response, status = BeyondAPI::Request.get(@session, "/carts/#{cart_id}") + response, status = BeyondApi::Request.get(@session, "/carts/#{cart_id}") handle_response(response, status) end @@ -540,7 +540,7 @@ def shipping_method(cart_id) # @cart = session.carts.shipping_methods("05a547a0-80dc-4a8c-b9b6-aa028b6ef7d8") # def shipping_methods(cart_id) - response, status = BeyondAPI::Request.get(@session, "/carts/#{cart_id}") + response, status = BeyondApi::Request.get(@session, "/carts/#{cart_id}") handle_response(response, status) end end diff --git a/lib/beyond_api/resources/categories.rb b/lib/beyond_api/resources/categories.rb index 6946306..b9602b1 100644 --- a/lib/beyond_api/resources/categories.rb +++ b/lib/beyond_api/resources/categories.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class Categories < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request is used to list all available categories in a paged manner. @@ -25,7 +25,7 @@ class Categories < Base # @categories = session.categories.all(size: 100, page: 0) # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/categories", params) + response, status = BeyondApi::Request.get(@session, "/categories", params) handle_response(response, status) end @@ -54,7 +54,7 @@ def all(params = {}) # @category = session.categories.create(body) # def create(body) - response, status = BeyondAPI::Request.post(@session, "/categories", body) + response, status = BeyondApi::Request.post(@session, "/categories", body) handle_response(response, status) end @@ -76,7 +76,7 @@ def create(body) # session.categories.delete("f461fb56-1984-4ade-bd4e-007c273cc923") # def delete(category_id) - response, status = BeyondAPI::Request.delete(@session, "/categories/#{category_id}") + response, status = BeyondApi::Request.delete(@session, "/categories/#{category_id}") handle_response(response, status, respond_with_true: true) end @@ -99,7 +99,7 @@ def delete(category_id) # @category = session.categories.find(category_id) # def find(category_id) - response, status = BeyondAPI::Request.get(@session, "/categories/#{category_id}") + response, status = BeyondApi::Request.get(@session, "/categories/#{category_id}") handle_response(response, status) end @@ -129,7 +129,7 @@ def find(category_id) # @category = session.categories.update("49250b7a-79a8-48d0-a71c-fc417965928d", body) # def patch(category_id, body) - response, status = BeyondAPI::Request.patch(@session, "/categories/#{category_id}", body) + response, status = BeyondApi::Request.patch(@session, "/categories/#{category_id}", body) handle_response(response, status) end @@ -160,7 +160,7 @@ def patch(category_id, body) # @category = session.categories.update(category_id, body) # def update(category_id, body) - response, status = BeyondAPI::Request.put(@session, "/categories/#{category_id}", body) + response, status = BeyondApi::Request.put(@session, "/categories/#{category_id}", body) handle_response(response, status) end diff --git a/lib/beyond_api/resources/categories_view.rb b/lib/beyond_api/resources/categories_view.rb index 8289565..ed3ee2a 100644 --- a/lib/beyond_api/resources/categories_view.rb +++ b/lib/beyond_api/resources/categories_view.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class CategoriesView < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request is used to list all product categories. @@ -23,7 +23,7 @@ class CategoriesView < Base # @categories = session.categories_view.all(size: 100, page: 0) # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/product-view/categories", params) + response, status = BeyondApi::Request.get(@session, "/product-view/categories", params) handle_response(response, status) end @@ -43,7 +43,7 @@ def all(params = {}) # @category = session.categories_view.find("23bb1430-6e82-40e4-9a92-4cb404da74a8") # def find(category_id) - response, status = BeyondAPI::Request.get(@session, "/product-view/categories/#{category_id}") + response, status = BeyondApi::Request.get(@session, "/product-view/categories/#{category_id}") handle_response(response, status) end @@ -65,7 +65,7 @@ def find(category_id) # @products = session.categories_view.products("681beef2-cd3e-4ce3-8034-4d07c1184447", { size: 100, page: 0 }) # def products(category_id, params = {}) - response, status = BeyondAPI::Request.get(@session, "/product-view/categories/#{category_id}/products", params) + response, status = BeyondApi::Request.get(@session, "/product-view/categories/#{category_id}/products", params) handle_response(response, status) end @@ -85,7 +85,7 @@ def products(category_id, params = {}) # @category = session.categories_view.search_by_label("power-bar") # def search_by_label(label) - response, status = BeyondAPI::Request.get(@session, "/product-view/categories/search/find-by-label", { label: label }) + response, status = BeyondApi::Request.get(@session, "/product-view/categories/search/find-by-label", { label: label }) handle_response(response, status) end @@ -105,7 +105,7 @@ def search_by_label(label) # @category = session.categories_view.search_by_product_id("ba68427f-603c-4741-9185-3b379f7769b5") # def search_by_product_id(product_id, params = {}) - response, status = BeyondAPI::Request.get(@session, "/product-view/categories/search/find-by-product", params.merge(product_id: product_id)) + response, status = BeyondApi::Request.get(@session, "/product-view/categories/search/find-by-product", params.merge(product_id: product_id)) handle_response(response, status) end @@ -134,7 +134,7 @@ def search_by_product_id(product_id, params = {}) # @category = session.categories_view.search_by_product_id("ba68427f-603c-4741-9185-3b379f7769b5") # def search_by_product(body, params = {}) - response, status = BeyondAPI::Request.post(@session, "/product-view/categories/search/find-by-product", body, params) + response, status = BeyondApi::Request.post(@session, "/product-view/categories/search/find-by-product", body, params) handle_response(response, status = {}) end diff --git a/lib/beyond_api/resources/checkout_settings.rb b/lib/beyond_api/resources/checkout_settings.rb index f0a3321..68073cd 100644 --- a/lib/beyond_api/resources/checkout_settings.rb +++ b/lib/beyond_api/resources/checkout_settings.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class CheckoutSettings < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request is used to retrieve the checkout settings. @@ -21,7 +21,7 @@ class CheckoutSettings < Base # @checkout_settiongs = session.checkout_settings.all # def all - response, status = BeyondAPI::Request.get(@session, "/checkout-settings") + response, status = BeyondApi::Request.get(@session, "/checkout-settings") handle_response(response, status) end @@ -40,7 +40,7 @@ def all # "mustAcceptTermsAndConditions" : true # }' def update(body) - response, status = BeyondAPI::Request.put(@session, "/checkout-settings", body) + response, status = BeyondApi::Request.put(@session, "/checkout-settings", body) handle_response(response, status) end diff --git a/lib/beyond_api/resources/newsletter_target.rb b/lib/beyond_api/resources/newsletter_target.rb index b270edb..048c5db 100644 --- a/lib/beyond_api/resources/newsletter_target.rb +++ b/lib/beyond_api/resources/newsletter_target.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class NewsletterTarget < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +POST+ request is used to create the newsletter target. Each shop can only have one newsletter target. @@ -28,7 +28,7 @@ class NewsletterTarget < Base # session.newsletter_target.create({ submit_url: "https://example.org/cgi-bin/subscribe.php" }) # def create(submit_url) - response, status = BeyondAPI::Request.post(@session, "/newsletter-target", { submit_url: submit_url}) + response, status = BeyondApi::Request.post(@session, "/newsletter-target", { submit_url: submit_url}) handle_response(response, status) end @@ -47,7 +47,7 @@ def create(submit_url) # session.newsletter_target.delete # def delete - response, status = BeyondAPI::Request.delete(@session, "/newsletter-target") + response, status = BeyondApi::Request.delete(@session, "/newsletter-target") handle_response(response, status, respond_with_true: true) end @@ -63,7 +63,7 @@ def delete # session.newsletter_target.find # def find - response, status = BeyondAPI::Request.get(@session, "/newsletter-target") + response, status = BeyondApi::Request.get(@session, "/newsletter-target") handle_response(response, status) end @@ -89,7 +89,7 @@ def find # session.newsletter_target.update({ submit_url: "https://example.org/cgi-bin/subscribe.php" }) # def update(submit_url) - response, status = BeyondAPI::Request.put(@session, "/newsletter-target", { submit_url: submit_url }) + response, status = BeyondApi::Request.put(@session, "/newsletter-target", { submit_url: submit_url }) handle_response(response, status) end diff --git a/lib/beyond_api/resources/order_settings.rb b/lib/beyond_api/resources/order_settings.rb index 6210e85..b7ed1a7 100644 --- a/lib/beyond_api/resources/order_settings.rb +++ b/lib/beyond_api/resources/order_settings.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class OrderSettings < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request is used to retrieve the order settings. @@ -21,7 +21,7 @@ class OrderSettings < Base # @order_settings = session.payment_methods.all # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/order-settings") + response, status = BeyondApi::Request.get(@session, "/order-settings") handle_response(response, status) end @@ -72,7 +72,7 @@ def all(params = {}) # @order_settings = session.order_settings.update(body) # def update(order_settings, body) - response, status = BeyondAPI::Request.put(@session, "/order-settings", body) + response, status = BeyondApi::Request.put(@session, "/order-settings", body) handle_response(response, status) end diff --git a/lib/beyond_api/resources/orders.rb b/lib/beyond_api/resources/orders.rb index 40ce13b..02b6842 100644 --- a/lib/beyond_api/resources/orders.rb +++ b/lib/beyond_api/resources/orders.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class Orders < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request is used to retrieve the active payment processes. There is only one active payment process. See {Show payment process details}[http://docs.beyondshop.cloud/#resources-payment-process-get] for more information about the request and response structure. @@ -24,7 +24,7 @@ class Orders < Base # @payment_process = session.orders.active_payment_process("268a8629-55cd-4890-9013-936b9b5ea14c") # def active_payment_process(order_id) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes/payments/active") + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/payments/active") handle_response(response, status) end @@ -47,7 +47,7 @@ def active_payment_process(order_id) # @refund_process = session.orders.active_refund_process("268a8629-55cd-9845-3114-454b9b5ea14c") # def active_refund_process(order_id) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes/refunds/active") + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/refunds/active") handle_response(response, status) end @@ -66,7 +66,7 @@ def active_refund_process(order_id) # @orders = session.orders.all(size: 100, page: 0) # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/orders", params) + response, status = BeyondApi::Request.get(@session, "/orders", params) handle_response(response, status) end @@ -96,7 +96,7 @@ def all(params = {}) # @order = session.orders.cancel("268a8629-55cd-4890-9013-936b9b5ea14c", body) # def cancel(order_id, body) - response, status = BeyondAPI::Request.post(@session, "/orders/#{order_id}/cancel", body) + response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/cancel", body) handle_response(response, status) end @@ -120,7 +120,7 @@ def cancel(order_id, body) # @pcancelation_process = session.orders.cancelation_process("268a8629-55cd-4890-9013-936b9b5ea14c", "365b4b63-45a8-49f6-94c5-a65e0dee83b5") # def cancelation_process(order_id, cancelation_id) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes/payments/cancelations/#{cancelation_id}") + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/payments/cancelations/#{cancelation_id}") handle_response(response, status) end @@ -145,7 +145,7 @@ def cancelation_process(order_id, cancelation_id) # @pcancelation_processes = session.orders.cancelation_processes("268a8629-55cd-4890-9013-936b9b5ea14c", {page: 0, size: 20}) # def cancelation_processes(order_id, params = {}) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes/payments/cancelations", params) + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/payments/cancelations", params) handle_response(response, status) end @@ -168,7 +168,7 @@ def cancelation_processes(order_id, params = {}) # @payment_process = session.orders.capture_payment_process("268a8629-55cd-4890-9013-936b9b5ea14c", "266d8608-55cd-4890-9474-296a9q1ea05q") # def capture_payment_process(order_id, payment_id) - response, status = BeyondAPI::Request.post(@session, "/orders/#{order_id}/processes/payments/#{payment_id}/capture", body) + response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/payments/#{payment_id}/capture", body) handle_response(response, status) end @@ -206,7 +206,7 @@ def capture_payment_process(order_id, payment_id) # @pcancelation_process = session.orders.create_cancelation_process("268a8629-55cd-4890-9013-936b9b5ea14c", body) # def create_cancelation_process(order_id, body) - response, status = BeyondAPI::Request.post(@session, "/orders/#{order_id}/processes/payments/cancelations") + response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/payments/cancelations") handle_response(response, status) end @@ -235,7 +235,7 @@ def create_cancelation_process(order_id, body) # @order = session.orders.create_invoice("268a8629-55cd-4890-9013-936b9b5ea14c", body) # def create_invoice(order_id, body) - response, status = BeyondAPI::Request.put(@session, "/orders/#{order_id}/create-invoice", body) + response, status = BeyondApi::Request.put(@session, "/orders/#{order_id}/create-invoice", body) handle_response(response, status) end @@ -285,7 +285,7 @@ def create_invoice(order_id, body) # @return_process = session.orders.create_return_process("268a8629-55cd-4890-9013-936b9b5ea14c", body) # def create_return_process(order_id, body) - response, status = BeyondAPI::Request.post(@session, "/orders/#{order_id}/processes/returns", body) + response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/returns", body) handle_response(response, status) end @@ -331,7 +331,7 @@ def create_return_process(order_id, body) # @shipping_process = session.orders.create_shipping_process("268a8629-55cd-9845-3114-454b9b5ea14c", "268a8629-55cd-4890-9013-936b9b5ea14a") # def create_shipping_process(order_id, body) - response, status = BeyondAPI::Request.post(@session, "/orders/#{order_id}/processes/shippings") + response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/shippings") handle_response(response, status) end @@ -355,7 +355,7 @@ def create_shipping_process(order_id, body) # @events = session.orders.find("268a8629-55cd-4890-9013-936b9b5ea14c") # def events(order_id, params = {}) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/events", params) + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/events", params) handle_response(response, status) end @@ -378,7 +378,7 @@ def events(order_id, params = {}) # @order = session.orders.find("268a8629-55cd-4890-9013-936b9b5ea14c") # def find(order_id) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}") + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}") handle_response(response, status) end @@ -422,7 +422,7 @@ def find(order_id) # @payment_process = session.orders.mark_payment_process_as_paid("268a8629-55cd-4890-9013-936b9b5ea14c", "266d8608-55cd-4890-9474-296a9q1ea05q", body) # def mark_payment_process_as_paid(order_id, payment_id, body) - response, status = BeyondAPI::Request.post(@session, "/orders/#{order_id}/processes/payments/#{payment_id}/mark-paid", body) + response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/payments/#{payment_id}/mark-paid", body) handle_response(response, status) end @@ -454,7 +454,7 @@ def mark_payment_process_as_paid(order_id, payment_id, body) # @payment_process = session.orders.mark_payment_process_as_voided("268a8629-55cd-4890-9013-936b9b5ea14c", "266d8608-55cd-4890-9474-296a9q1ea05q", body) # def mark_payment_process_as_voided(order_id, payment_id, body) - response, status = BeyondAPI::Request.post(@session, "/orders/#{order_id}/processes/payments/#{payment_id}/mark-voided", body) + response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/payments/#{payment_id}/mark-voided", body) handle_response(response, status) end @@ -495,7 +495,7 @@ def mark_payment_process_as_voided(order_id, payment_id, body) # @refund_process = session.orders.mark_refund_process_as_paid("268a8629-55cd-9845-3114-454b9b5ea14c", body) # def mark_refund_process_as_paid(order_id) - response, status = BeyondAPI::Request.post(@session, "/orders/#{order_id}/processes/refunds/active/mark-paid") + response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/refunds/active/mark-paid") handle_response(response, status) end @@ -527,7 +527,7 @@ def mark_refund_process_as_paid(order_id) # @shipping_process = session.orders.mark_shipping_process_as_delivered("268a8629-55cd-4890-9013-936b9b5ea14c", "266d8608-55cd-4890-9474-296a9q1ea05q", body) # def mark_shipping_process_as_delivered(order_id, shipping_id, body) - response, status = BeyondAPI::Request.post(@session, "/orders/#{order_id}/processes/shippings/#{payment_id}/mark-delivered", body) + response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/shippings/#{payment_id}/mark-delivered", body) handle_response(response, status) end @@ -569,7 +569,7 @@ def mark_shipping_process_as_delivered(order_id, shipping_id, body) # @shipping_process = session.orders.mark_shipping_process_as_shipped("268a8629-55cd-4890-9013-936b9b5ea14c", "266d8608-55cd-4890-9474-296a9q1ea05q", body) # def mark_shipping_process_as_shipped(order_id, shipping_id, body) - response, status = BeyondAPI::Request.post(@session, "/orders/#{order_id}/processes/shippings/#{shipping_id}/mark-shipped", body) + response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/processes/shippings/#{shipping_id}/mark-shipped", body) handle_response(response, status) end @@ -593,7 +593,7 @@ def mark_shipping_process_as_shipped(order_id, shipping_id, body) # @payment_process = session.orders.payment_process("268a8629-55cd-4890-9013-936b9b5ea14c", "266d8608-55cd-4890-9474-296a9q1ea05q") # def payment_process(order_id, payment_id) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes/payments/#{payment_id}") + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/payments/#{payment_id}") handle_response(response, status) end @@ -618,7 +618,7 @@ def payment_process(order_id, payment_id) # @payment_processes = session.orders.payment_processes("268a8629-55cd-4890-9013-936b9b5ea14c", {page: 0, size: 20}) # def payment_processes(order_id, params = {}) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes/payments", params) + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/payments", params) handle_response(response, status) end @@ -641,7 +641,7 @@ def payment_processes(order_id, params = {}) # @orders = session.orders.processes("268a8629-55cd-4890-9013-936b9b5ea14c") # def processes(order_id) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes") + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes") handle_response(response, status) end @@ -665,7 +665,7 @@ def processes(order_id) # @refund_process = session.orders.refund_process("268a8629-55cd-9845-3114-454b9b5ea14c", "268a8629-55cd-4890-9013-936b9b5ea14a") # def refund_process(order_id, refund_id) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes/refunds/#{refund_id}") + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/refunds/#{refund_id}") handle_response(response, status) end @@ -690,7 +690,7 @@ def refund_process(order_id, refund_id) # @refund_processes = session.orders.refund_processes("268a8629-55cd-4890-9013-936b9b5ea14c", {page: 0, size: 20}) # def refund_processes(order_id, params = {}) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes/refunds", params) + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/refunds", params) handle_response(response, status) end @@ -714,7 +714,7 @@ def refund_processes(order_id, params = {}) # @return_process = session.orders.return_process("268a8629-55cd-4890-9013-936b9b5ea14c", "910a3fde-cb23-418f-876a-694ce42245ef") # def return_process(order_id, return_process_id) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes/returns/#{return_process_id}") + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/returns/#{return_process_id}") handle_response(response, status) end @@ -739,7 +739,7 @@ def return_process(order_id, return_process_id) # @return_processes = session.orders.return_processes("268a8629-55cd-4890-9013-936b9b5ea14c", {page: 0, size: 20}) # def return_processes(order_id, params = {}) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes/returns", params) + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/returns", params) handle_response(response, status) end @@ -757,7 +757,7 @@ def return_processes(order_id, params = {}) # @order = session.orders.search_by_cart_id("268a8629-55cd-4890-9013-936b9b5ea14c") # def search_by_cart_id(cart_id) - response, status = BeyondAPI::Request.get(@session, "/orders/search/find-by-cart-id", {"cartId": cart_id}) + response, status = BeyondApi::Request.get(@session, "/orders/search/find-by-cart-id", {"cartId": cart_id}) handle_response(response, status) end @@ -773,7 +773,7 @@ def search_by_cart_id(cart_id) # @order = session.orders.search_by_cart_id("268a8629-55cd-4890-9013-936b9b5ea14c") # def search_order_number_by_cart_id(cart_id) - response, status = BeyondAPI::Request.get(@session, "/orders/search/find-order-number-by-cart-id", {"cartId": cart_id}) + response, status = BeyondApi::Request.get(@session, "/orders/search/find-order-number-by-cart-id", {"cartId": cart_id}) handle_response(response, status) end @@ -793,7 +793,7 @@ def search_order_number_by_cart_id(cart_id) # @order = session.orders.send_invoice("268a8629-55cd-4890-9013-936b9b5ea14c") # def send_invoice(order_id) - response, status = BeyondAPI::Request.post(@session, "/orders/#{order_id}/send-invoice") + response, status = BeyondApi::Request.post(@session, "/orders/#{order_id}/send-invoice") handle_response(response, status) end @@ -817,7 +817,7 @@ def send_invoice(order_id) # @shipping_process = session.orders.refund_process("268a8629-55cd-9845-3114-454b9b5ea14c", "268a8629-55cd-4890-9013-936b9b5ea14a") # def shipping_process(order_id, shipping_process_id) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes/shippings/#{shipping_process_id}") + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/shippings/#{shipping_process_id}") handle_response(response, status) end @@ -842,7 +842,7 @@ def shipping_process(order_id, shipping_process_id) # @shipping_processes = session.orders.shipping_processes("268a8629-55cd-4890-9013-936b9b5ea14c", {page: 0, size: 20}) # def shipping_processes(order_id, params = {}) - response, status = BeyondAPI::Request.get(@session, "/orders/#{order_id}/processes/shippings", params) + response, status = BeyondApi::Request.get(@session, "/orders/#{order_id}/processes/shippings", params) handle_response(response, status) end @@ -890,7 +890,7 @@ def shipping_processes(order_id, params = {}) # @order = session.orders.update_billing_address("268a8629-55cd-4890-9013-936b9b5ea14c", body) # def update_billing_address(order_id, body) - response, status = BeyondAPI::Request.put(@session, "/orders/#{order_id}/billing-address", body) + response, status = BeyondApi::Request.put(@session, "/orders/#{order_id}/billing-address", body) handle_response(response, status) end @@ -912,7 +912,7 @@ def update_billing_address(order_id, body) # @order = session.orders.update_order_note("268a8629-55cd-4890-9013-936b9b5ea14c", body) # def update_order_note(order_id, body) - response, status = BeyondAPI::Request.put(@session, "/orders/#{order_id}/order-note", body) + response, status = BeyondApi::Request.put(@session, "/orders/#{order_id}/order-note", body) handle_response(response, status) end @@ -960,7 +960,7 @@ def update_order_note(order_id, body) # @order = session.orders.update_shipping_address("268a8629-55cd-4890-9013-936b9b5ea14c", body) # def update_shipping_address(order_id, body) - response, status = BeyondAPI::Request.put(@session, "/orders/#{order_id}/shipping-address", body) + response, status = BeyondApi::Request.put(@session, "/orders/#{order_id}/shipping-address", body) handle_response(response, status) end diff --git a/lib/beyond_api/resources/payment_methods.rb b/lib/beyond_api/resources/payment_methods.rb index df533fd..a1b3335 100644 --- a/lib/beyond_api/resources/payment_methods.rb +++ b/lib/beyond_api/resources/payment_methods.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class PaymentMethods < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +POST+ request is used to activate a payment method. @@ -23,7 +23,7 @@ class PaymentMethods < Base # session.payment_methods.activate("268a8629-55cd-4890-9013-936b9b5ea14c") # def activate(payment_method_id) - response, status = BeyondAPI::Request.post(@session, "/payment-methods/#{payment_method_id}/activate") + response, status = BeyondApi::Request.post(@session, "/payment-methods/#{payment_method_id}/activate") handle_response(response, status, respond_with_true: true) end @@ -47,7 +47,7 @@ def activate(payment_method_id) # session.payment_methods.all(size: 100, page: 0) # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/payment-methods", params) + response, status = BeyondApi::Request.get(@session, "/payment-methods", params) handle_response(response, status) end @@ -69,7 +69,7 @@ def all(params = {}) # session.payment_methods.deactivate("268a8629-55cd-4890-9013-936b9b5ea14c") # def deactivate(payment_method_id) - response, status = BeyondAPI::Request.post(@session, "/payment-methods/#{payment_method_id}/deactivate") + response, status = BeyondApi::Request.post(@session, "/payment-methods/#{payment_method_id}/deactivate") handle_response(response, status, respond_with_true: true) end @@ -87,7 +87,7 @@ def deactivate(payment_method_id) # session.payment_methods.find("268a8629-55cd-4890-9013-936b9b5ea14c") # def find(payment_method_id) - response, status = BeyondAPI::Request.get(@session, "/payment-methods/#{payment_method_id}") + response, status = BeyondApi::Request.get(@session, "/payment-methods/#{payment_method_id}") handle_response(response, status) end @@ -123,7 +123,7 @@ def sort(payment_method_ids) payment_method_ids.each do |payment_method| body << "#{@session.api_url}/payment-methods/#{payment_method}" end - response, status = BeyondAPI::Request.put(@session, "/payment-methods", body) + response, status = BeyondApi::Request.put(@session, "/payment-methods", body) handle_response(response, status, respond_with_true: true) end @@ -184,7 +184,7 @@ def sort(payment_method_ids) # @payment_method = session.payment_methods.update("6f3bc033-c2d1-4f44-80e3-1b668f6bd699", body) # def update(payment_method_id, body) - response, status = BeyondAPI::Request.put(@session, "/payment-methods/#{payment_method_id}", body) + response, status = BeyondApi::Request.put(@session, "/payment-methods/#{payment_method_id}", body) handle_response(response, status) end diff --git a/lib/beyond_api/resources/product_attribute_definitions.rb b/lib/beyond_api/resources/product_attribute_definitions.rb index 3b3ad5b..317432a 100644 --- a/lib/beyond_api/resources/product_attribute_definitions.rb +++ b/lib/beyond_api/resources/product_attribute_definitions.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class ProductAttributeDefinitions < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request will list the available product attribute definitions. @@ -23,7 +23,7 @@ class ProductAttributeDefinitions < Base # @product_attribute_definitions = session.product_attribute_definitions.all(size: 100, page: 0) # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/product-attribute-definitions", params) + response, status = BeyondApi::Request.get(@session, "/product-attribute-definitions", params) handle_response(response, status) end @@ -57,7 +57,7 @@ def all(params = {}) # @product_attribute_definition = session.product_attribute_definitions.create(body) # def create(product_attribute_name) - response, status = BeyondAPI::Request.post(@session, "/product-attribute-definitions") + response, status = BeyondApi::Request.post(@session, "/product-attribute-definitions") handle_response(response, status) end @@ -80,7 +80,7 @@ def create(product_attribute_name) # session.product_attribute_definitions.delete("filling_capacity") # def delete(product_attribute_name) - response, status = BeyondAPI::Request.get(@session, "/product-attribute-definitions/#{product_attribute_name}") + response, status = BeyondApi::Request.get(@session, "/product-attribute-definitions/#{product_attribute_name}") handle_response(response, status, respond_with_true: true) end @@ -101,7 +101,7 @@ def delete(product_attribute_name) # @product_attribute_definition = session.product_attribute_definitions.find("filling_capacity") # def find(product_attribute_name) - response, status = BeyondAPI::Request.get(@session, "/product-attribute-definitions/#{product_attribute_name}") + response, status = BeyondApi::Request.get(@session, "/product-attribute-definitions/#{product_attribute_name}") handle_response(response, status) end diff --git a/lib/beyond_api/resources/product_settings.rb b/lib/beyond_api/resources/product_settings.rb index ea97ddf..fae274b 100644 --- a/lib/beyond_api/resources/product_settings.rb +++ b/lib/beyond_api/resources/product_settings.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class ProductSettings < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request is used to retrieve the product settings. @@ -20,7 +20,7 @@ class ProductSettings < Base # @product_settings = session.product_settings.all # def all - response, status = BeyondAPI::Request.get(@session, "/product_settings") + response, status = BeyondApi::Request.get(@session, "/product_settings") handle_response(response, status) end diff --git a/lib/beyond_api/resources/products.rb b/lib/beyond_api/resources/products.rb index 1ede04c..89d6764 100644 --- a/lib/beyond_api/resources/products.rb +++ b/lib/beyond_api/resources/products.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class Products < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request will list all of the products in a paged manner. The returned data is an excerpt projection, which includes a small subset of product properties. @@ -25,7 +25,7 @@ class Products < Base # @products = session.products.all(size: 100, page: 0) # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/products", params) + response, status = BeyondApi::Request.get(@session, "/products", params) handle_response(response, status) end @@ -152,7 +152,7 @@ def all(params = {}) # @product = session.products.create(body) # def create(body) - response, status = BeyondAPI::Request.post(@session, "/products", body) + response, status = BeyondApi::Request.post(@session, "/products", body) handle_response(response, status) end @@ -174,7 +174,7 @@ def create(body) # session.products.delete("f461fb56-1984-4ade-bd4e-007c273cc923") # def delete(product_id) - response, status = BeyondAPI::Request.delete(@session, "/products/#{product_id}") + response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}") handle_response(response, status, respond_with_true: true) end @@ -197,7 +197,7 @@ def delete(product_id) # @product = session.products.find("f461fb56-1984-4ade-bd4e-007c273cc923") # def find(product_id) - response, status = BeyondAPI::Request.get(@session, "/products/#{product_id}") + response, status = BeyondApi::Request.get(@session, "/products/#{product_id}") handle_response(response, status) end @@ -233,7 +233,7 @@ def find(product_id) # @product = session.products.update("75ebcb57-aefb-4963-8225-060c528e070d", body) # def update(product_id, body) - response, status = BeyondAPI::Request.patch(@session, "/products/#{product_id}", body) + response, status = BeyondApi::Request.patch(@session, "/products/#{product_id}", body) handle_response(response, status) end diff --git a/lib/beyond_api/resources/products/attachments.rb b/lib/beyond_api/resources/products/attachments.rb index 5f00153..00fec7c 100644 --- a/lib/beyond_api/resources/products/attachments.rb +++ b/lib/beyond_api/resources/products/attachments.rb @@ -2,7 +2,7 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi module ProductAttachments # @@ -37,7 +37,7 @@ module ProductAttachments # @attachment = session.products.add_attachment("fd60a63e-c4c0-496d-af49-c4ed224cca2a", body) # def add_attachment(product_id, body) - response, status = BeyondAPI::Request.post(@session, "/products/#{product_id}/attachments", body) + response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/attachments", body) handle_response(response, status) end @@ -61,7 +61,7 @@ def add_attachment(product_id, body) # @attachment = session.products.attachment("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "36933722-f13f-4ee2-858c-0835ae0a884e") # def attachment(product_id, attachment_id) - response, status = BeyondAPI::Request.get(@session, "/products/#{product_id}/attachments/#{attachment_id}") + response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/attachments/#{attachment_id}") handle_response(response, status) end @@ -86,7 +86,7 @@ def attachment(product_id, attachment_id) # @attachments = session.products.attachments("fd60a63e-c4c0-496d-af49-c4ed224cca2a", size: 100, page: 0) # def attachments(product_id, params) - response, status = BeyondAPI::Request.get(@session, "/products/#{product_id}/attachments", params) + response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/attachments", params) handle_response(response, status) end @@ -110,7 +110,7 @@ def attachments(product_id, params) # session.products.delete_attachment("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "36933722-f13f-4ee2-858c-0835ae0a884e") # def delete_attachment(product_id, attachment_id) - response, status = BeyondAPI::Request.delete(@session, "/products/#{product_id}/attachments/#{attachment_id}") + response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}/attachments/#{attachment_id}") handle_response(response, status, respond_with_true: true) end diff --git a/lib/beyond_api/resources/products/availability.rb b/lib/beyond_api/resources/products/availability.rb index d3e9c6b..da15c87 100644 --- a/lib/beyond_api/resources/products/availability.rb +++ b/lib/beyond_api/resources/products/availability.rb @@ -2,7 +2,7 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi module ProductAvailability # @@ -24,7 +24,7 @@ module ProductAvailability # @availability = session.products.adjust_stock_level(product_id, { relativeAmount => -1 }) # def adjust_stock_level(product_id, body) - response, status = BeyondAPI::Request.post(@session, "/products/#{product_id}/availability/enable-stock-management", body) + response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/enable-stock-management", body) handle_response(response, status) end @@ -47,7 +47,7 @@ def adjust_stock_level(product_id, body) # @availability = session.products.availability("fb22d408-00dc-47e3-ae58-e35769bdb428") # def availability(product_id) - response, status = BeyondAPI::Request.get(@session, "/products/#{product_id}/availability") + response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/availability") handle_response(response, status) end @@ -70,7 +70,7 @@ def availability(product_id) # session.products.disable_purchasability("17e3a92b-6f3b-4415-bd8f-c9c8921a5a73") # def disable_purchasability(product_id) - response, status = BeyondAPI::Request.post(@session, "/products/#{product_id}/availability/disable-purchasability") + response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/disable-purchasability") handle_response(response, status, respond_with_true: true) end @@ -93,7 +93,7 @@ def disable_purchasability(product_id) # session.products.disable_stock_management("e966cb17-4047-4b82-ade4-33e7f0978c89", respond_with_true: true) # def disable_stock_management(product_id) - response, status = BeyondAPI::Request.post(@session, "/products/#{product_id}/availability/disable-stock-management") + response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/disable-stock-management") handle_response(response, status, respond_with_true: true) end @@ -116,7 +116,7 @@ def disable_stock_management(product_id) # session.products.enable_purchasability("17e3a92b-6f3b-4415-bd8f-c9c8921a5a73") # def enable_purchasability(product_id) - response, status = BeyondAPI::Request.post(@session, "/products/#{product_id}/availability/enable-purchasability") + response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/enable-purchasability") handle_response(response, status, respond_with_true: true) end @@ -145,7 +145,7 @@ def enable_purchasability(product_id) # @availability = session.products.enable_stock_management("101fa968-9bb8-4dbe-b166-3add1fc1b35e", body) # def enable_stock_management(product_id, body) - response, status = BeyondAPI::Request.post(@session, "/products/#{product_id}/availability/enable-stock-management", body) + response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/enable-stock-management", body) handle_response(response, status) end @@ -169,7 +169,7 @@ def enable_stock_management(product_id, body) # session.products.update_reserve_stock("f74b5f57-43cc-4176-97aa-c6eb9fdeb37c", { stockThreshold => 5 }) # def update_reserve_stock(product_id, body) - response, status = BeyondAPI::Request.post(@session, "/products/#{product_id}/availability/update-stock-threshold", body) + response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/update-stock-threshold", body) handle_response(response, status) end diff --git a/lib/beyond_api/resources/products/custom_attributes.rb b/lib/beyond_api/resources/products/custom_attributes.rb index cf158e2..eae7f0d 100644 --- a/lib/beyond_api/resources/products/custom_attributes.rb +++ b/lib/beyond_api/resources/products/custom_attributes.rb @@ -2,7 +2,7 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi module ProductCustomAttribute # @@ -32,7 +32,7 @@ module ProductCustomAttribute # @custom_attribute = session.products.attachment("fd60a63e-c4c0-496d-af49-c4ed224cca2a", body) # def create_custom_attribute(product_id, body) - response, status = BeyondAPI::Request.post(@session, "/products/#{product_id}/attributes", body) + response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/attributes", body) handle_response(response, status) end @@ -56,7 +56,7 @@ def create_custom_attribute(product_id, body) # @custom_attribute = session.products.custom_attribute("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "key") # def custom_attribute(product_id, attribute_name) - response, status = BeyondAPI::Request.get(@session, "/products/#{product_id}/attributes/#{attribute_name}") + response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/attributes/#{attribute_name}") handle_response(response, status) end @@ -79,7 +79,7 @@ def custom_attribute(product_id, attribute_name) # @custom_attributes = session.products.custom_attributes("fd60a63e-c4c0-496d-af49-c4ed224cca2a") # def custom_attributes(product_id) - response, status = BeyondAPI::Request.get(@session, "/products/#{product_id}/attributes") + response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/attributes") handle_response(response, status) end @@ -102,7 +102,7 @@ def custom_attributes(product_id) # session.products.custom_attribute("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "key") # def delete_custom_attribute(product_id, attribute_name) - response, status = BeyondAPI::Request.delete(@session, "/products/#{product_id}/attributes/#{attribute_name}") + response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}/attributes/#{attribute_name}") handle_response(response, status, respond_with_true: true) end @@ -133,7 +133,7 @@ def delete_custom_attribute(product_id, attribute_name) # @custom_attribute = session.products.update_custom_attribute("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "key", body) # def update_custom_attribute(product_id, attribute_name, body) - response, status = BeyondAPI::Request.put(@session, "/products/#{product_id}/attributes/#{attribute_name}", body) + response, status = BeyondApi::Request.put(@session, "/products/#{product_id}/attributes/#{attribute_name}", body) handle_response(response, status) end diff --git a/lib/beyond_api/resources/products/images.rb b/lib/beyond_api/resources/products/images.rb index 52a4476..eaac846 100644 --- a/lib/beyond_api/resources/products/images.rb +++ b/lib/beyond_api/resources/products/images.rb @@ -2,7 +2,7 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi module ProductImages @@ -27,7 +27,7 @@ module ProductImages # @image = session.products.add_image(product_id, { dataUri: "photostore-2.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998" }) # def add_image(product_id, image_uri) - response, status = BeyondAPI::Request.post(@session, "/products/#{product_id}/images", { dataUri: image_uri}) + response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/images", { dataUri: image_uri}) handle_response(response, status) end @@ -51,7 +51,7 @@ def add_image(product_id, image_uri) # session.products.delete_image("8f5e979e-4a47-47ca-84ce-7c026d623974", "ac318d53-df29-4f43-9356-d91aed8bdb39") # def delete_image(product_id, image_id) - response, status = BeyondAPI::Request.delete(@session, "/products/#{product_id}/images/#{image_id}") + response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}/images/#{image_id}") handle_response(response, status, respond_with_true: true) end @@ -76,7 +76,7 @@ def delete_image(product_id, image_id) # @products = session.products.images("7f32696a-df56-4380-a91b-fffb97f025b4", { size: 20, page: 0 }) # def images(product_id, params = {}) - response, status = BeyondAPI::Request.get(@session, "/products/#{product_id}/images", params) + response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/images", params) handle_response(response, status) end @@ -99,7 +99,7 @@ def images(product_id, params = {}) # @image = session.products.image("124c5c94-4e62-410a-8599-e5b29dae3491", "715f5154-9fde-4213-bcab-41ceaaf8b70e") # def image(product_id, image_id) - response, status = BeyondAPI::Request.get(@session, "/products/#{product_id}/images/#{image_id}") + response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/images/#{image_id}") handle_response(response, status) end @@ -123,7 +123,7 @@ def image(product_id, image_id) # session.products.set_image_as_default("150015b9-0b9b-45a2-bcfb-f9006b16a8b8", "8ef3591c-d05f-4aa1-acf6-950ba51ec4f7") # def set_image_as_default(product_id, image_id) - response, status = BeyondAPI::Request.put(@session, "/products/#{product_id}", + response, status = BeyondApi::Request.put(@session, "/products/#{product_id}", "#{@session.api_url}/productsimages/#{image_id}") handle_response(response, status, respond_with_true: true) @@ -157,7 +157,7 @@ def upload_image(product_id, image_path, image_name) end image_binary = File.binread(image_path) - response, status = BeyondAPI::Request.upload(@session, "/products/#{product_id}/images", image_binary, content_type, { file_name: image_name }) + response, status = BeyondApi::Request.upload(@session, "/products/#{product_id}/images", image_binary, content_type, { file_name: image_name }) handle_response(response, status, respond_with_true: true) end diff --git a/lib/beyond_api/resources/products/searches.rb b/lib/beyond_api/resources/products/searches.rb index 3e02142..45fc4ec 100644 --- a/lib/beyond_api/resources/products/searches.rb +++ b/lib/beyond_api/resources/products/searches.rb @@ -2,7 +2,7 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi module ProductSearches # @@ -21,7 +21,7 @@ module ProductSearches # @product = session.product.search_by_sku("vino020") # def search_by_sku(sku) - response, status = BeyondAPI::Request.get(@session, "/products/search/find-by-sku", sku: sku) + response, status = BeyondApi::Request.get(@session, "/products/search/find-by-sku", sku: sku) handle_response(response, status) end @@ -44,7 +44,7 @@ def search_by_sku(sku) # @tags = session.product.search_tags_starting_by("aw") # def search_tags_starting_by(starts_with, params = {}) - response, status = BeyondAPI::Request.get(@session, "/products/search/tags", params.merge(starts_with: starts_with)) + response, status = BeyondApi::Request.get(@session, "/products/search/tags", params.merge(starts_with: starts_with)) handle_response(response, status) end diff --git a/lib/beyond_api/resources/products/variation_properties.rb b/lib/beyond_api/resources/products/variation_properties.rb index b0476c3..50e0bb7 100644 --- a/lib/beyond_api/resources/products/variation_properties.rb +++ b/lib/beyond_api/resources/products/variation_properties.rb @@ -2,7 +2,7 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi module ProductVariationProperties # @@ -57,7 +57,7 @@ module ProductVariationProperties # @variation_properties = session.products.update_variation_properties("7f32696a-df56-4380-a91b-fffb97f025b4", body) # def update_variation_properties(product_id, body) - response, status = BeyondAPI::Request.patch(@session, "/products/#{product_id}/variation-properties", body) + response, status = BeyondApi::Request.patch(@session, "/products/#{product_id}/variation-properties", body) handle_response(response, status) end @@ -79,7 +79,7 @@ def update_variation_properties(product_id, body) # @variation_properties = session.products.variation_properties("7f32696a-df56-4380-a91b-fffb97f025b4") # def variation_properties(product_id) - response, status = BeyondAPI::Request.get(@session, "/products/#{product_id}/variation-properties") + response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variation-properties") handle_response(response, status) end diff --git a/lib/beyond_api/resources/products_view.rb b/lib/beyond_api/resources/products_view.rb index b57b42e..48327ac 100644 --- a/lib/beyond_api/resources/products_view.rb +++ b/lib/beyond_api/resources/products_view.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class ProductsView < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request is used to list all products. @@ -22,7 +22,7 @@ class ProductsView < Base # @products = session.product_view_products.all(page: 0, size: 100) # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/product-view/products") + response, status = BeyondApi::Request.get(@session, "/product-view/products") handle_response(response, status) end @@ -40,7 +40,7 @@ def all(params = {}) # @tags = session.product_view_products.available_tags # def available_tags - response, status = BeyondAPI::Request.get(@session, "/product-view/products/search/find-available-tags") + response, status = BeyondApi::Request.get(@session, "/product-view/products/search/find-available-tags") handle_response(response, status) end @@ -61,7 +61,7 @@ def available_tags # @product = session.product_view_products.find("e3e86c45-de19-4179-87a4-f5f7756a0294") # def find(product_id) - response, status = BeyondAPI::Request.get(@session, "/product-view/products/#{product_id}") + response, status = BeyondApi::Request.get(@session, "/product-view/products/#{product_id}") handle_response(response, status) end @@ -106,7 +106,7 @@ def find(product_id) # @products = session.product_view_products.search_by_query(body) # def search_by_query(query) - response, status = BeyondAPI::Request.post(@session, "/product-view/products/search/find-by-query", body) + response, status = BeyondApi::Request.post(@session, "/product-view/products/search/find-by-query", body) handle_response(response, status) end @@ -128,7 +128,7 @@ def search_by_query(query) # @products = session.product_view_products.search_by_tag("number0", page: 0, size: 100) # def search_by_tag(tag, params = {}) - response, status = BeyondAPI::Request.get(@session, "/product-view/products/search/find-by-tags", params.merge(tag: tag)) + response, status = BeyondApi::Request.get(@session, "/product-view/products/search/find-by-tags", params.merge(tag: tag)) handle_response(response, status) end @@ -150,7 +150,7 @@ def search_by_tag(tag, params = {}) # @products = session.product_view_products.search_by_term("search snippet", page: 0, size: 100) # def search_by_term(term, params = {}) - response, status = BeyondAPI::Request.get(@session, "/product-view/products/search/find-by-term", params.merge(query: term)) + response, status = BeyondApi::Request.get(@session, "/product-view/products/search/find-by-term", params.merge(query: term)) handle_response(response, status) end diff --git a/lib/beyond_api/resources/scopes.rb b/lib/beyond_api/resources/scopes.rb index 5ade05d..cc439ec 100644 --- a/lib/beyond_api/resources/scopes.rb +++ b/lib/beyond_api/resources/scopes.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class Scopes < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request will list all scopes in the system. @@ -23,7 +23,7 @@ class Scopes < Base # @scopes = session.scopes.all(size: 20, page: 0) # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/scopes", params) + response, status = BeyondApi::Request.get(@session, "/scopes", params) handle_response(response, status) end diff --git a/lib/beyond_api/resources/script_tags.rb b/lib/beyond_api/resources/script_tags.rb index b9b4ddf..f7d5a3f 100644 --- a/lib/beyond_api/resources/script_tags.rb +++ b/lib/beyond_api/resources/script_tags.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class ScriptTags < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request is used to retrieve a list of all script tags for a shop. @@ -21,7 +21,7 @@ class ScriptTags < Base # @script_tags = session.script_tags.all(size: 20, page: 0) # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/script-tags", params) + response, status = BeyondApi::Request.get(@session, "/script-tags", params) handle_response(response, status) end @@ -40,7 +40,7 @@ def all(params = {}) # @script_tag = session.script_tags.find("df170ab1-13ae-4955-8b51-2478246acf59") # def find(script_tag_id) - response, status = BeyondAPI::Request.get(@session, "/script-tags/#{script_tag_id}") + response, status = BeyondApi::Request.get(@session, "/script-tags/#{script_tag_id}") handle_response(response, status) end @@ -66,7 +66,7 @@ def find(script_tag_id) # @script_tag = session.script_tags.create("https://example.org/js/fancy-script.js") # def create(script_tag_url) - response, status = BeyondAPI::Request.post(@session, "/script-tags", { script_url: script_tag_url }) + response, status = BeyondApi::Request.post(@session, "/script-tags", { script_url: script_tag_url }) handle_response(response, status) end @@ -87,7 +87,7 @@ def create(script_tag_url) # session.script_tags.delete("4a9f7776-d74d-4311-8ddb-121bd5407520") # def delete(script_tag_id) - response, status = BeyondAPI::Request.delete(@session, "/script-tags/#{script_tag_id}") + response, status = BeyondApi::Request.delete(@session, "/script-tags/#{script_tag_id}") handle_response(response, status, respond_with_true: true) end @@ -114,7 +114,7 @@ def delete(script_tag_id) # @script_tag = session.script_tags.create("https://example.org/scripts/someOtherScript.js") # def update(script_tag_id, script_tag_url) - response, status = BeyondAPI::Request.put(@session, "/script-tags/#{script_tag_id}", { script_url: script_tag_url }) + response, status = BeyondApi::Request.put(@session, "/script-tags/#{script_tag_id}", { script_url: script_tag_url }) handle_response(response, status) end diff --git a/lib/beyond_api/resources/shipping_zones.rb b/lib/beyond_api/resources/shipping_zones.rb index f3ce3b6..2821d42 100644 --- a/lib/beyond_api/resources/shipping_zones.rb +++ b/lib/beyond_api/resources/shipping_zones.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class ShippingZones < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request is used to list all shipping zones in a paged way. @@ -23,7 +23,7 @@ class ShippingZones < Base # @shipping_zones = session.shipping_zones.all(size: 20, page: 0) # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/shipping-zones", params) + response, status = BeyondApi::Request.get(@session, "/shipping-zones", params) handle_response(response, status) end @@ -53,7 +53,7 @@ def all(params = {}) # @shipping_zone = session.shipping_zones.create(body) # def create(body) - response, status = BeyondAPI::Request.post(@session, "/shipping-zones", body) + response, status = BeyondApi::Request.post(@session, "/shipping-zones", body) handle_response(response, status) end @@ -106,7 +106,7 @@ def create(body) # @shipping_zone = session.shipping_zones.create("905e981c-1489-45af-9138-0a7dc1f0b085", body) # def create_shipping_method(shipping_zone_id, body) - response, status = BeyondAPI::Request.post(@session, "/shipping-zones/#{shipping_zone_id}/shipping-methods", body) + response, status = BeyondApi::Request.post(@session, "/shipping-zones/#{shipping_zone_id}/shipping-methods", body) handle_response(response, status) end @@ -127,7 +127,7 @@ def create_shipping_method(shipping_zone_id, body) # session.shipping_zones.delete("c871b402-b6d9-4c6d-b76c-440f61175805") # def delete(shipping_zone_id) - response, status = BeyondAPI::Request.delete(@session, "/shipping-zones/#{shipping_zone_id}") + response, status = BeyondApi::Request.delete(@session, "/shipping-zones/#{shipping_zone_id}") handle_response(response, status, respond_with_true: true) end @@ -149,7 +149,7 @@ def delete(shipping_zone_id) # session.shipping_zones.delete_shipping_method("61c14c3c-ce26-4524-9713-f2ede7ff22fa", "d2eee203-a1c6-4035-8e7a-74bb77cfde47") # def delete_shipping_method(shipping_zone_id, shipping_method_id) - response, status = BeyondAPI::Request.delete(@session, "/shipping-zones/#{shipping_zone_id}/shipping_methods/#{shipping_method_id}") + response, status = BeyondApi::Request.delete(@session, "/shipping-zones/#{shipping_zone_id}/shipping_methods/#{shipping_method_id}") handle_response(response, status, respond_with_true: true) end @@ -171,7 +171,7 @@ def delete_shipping_method(shipping_zone_id, shipping_method_id) # @shipping_zone = session.shipping_zones.find("27914098-c1f6-46aa-9e78-c7ac873e25b3") # def find(shipping_zone_id) - response, status = BeyondAPI::Request.get(@session, "/shipping-zones/#{shipping_zone_id}") + response, status = BeyondApi::Request.get(@session, "/shipping-zones/#{shipping_zone_id}") handle_response(response, status) end @@ -188,7 +188,7 @@ def find(shipping_zone_id) # @serviceable_countries = session.shipping_zones.find_serviceable_countries # def find_serviceable_countries - response, status = BeyondAPI::Request.get(@session, "/shipping-zones/search/find-all-serviceable-countries") + response, status = BeyondApi::Request.get(@session, "/shipping-zones/search/find-all-serviceable-countries") handle_response(response, status) end @@ -210,7 +210,7 @@ def find_serviceable_countries # @shipping_method = session.shipping_zones.shipping_method("61780dd6-0150-4fcf-953c-d10c52bab4ab", "13bd1fc9-706c-4774-923a-484a41aaab89") # def shipping_method(shipping_zone_id, shipping_method_id) - response, status = BeyondAPI::Request.get(@session, "/shipping-zones/#{shipping_zone_id}/shipping-methods/#{shipping_method_id}") + response, status = BeyondApi::Request.get(@session, "/shipping-zones/#{shipping_zone_id}/shipping-methods/#{shipping_method_id}") handle_response(response, status) end @@ -234,7 +234,7 @@ def shipping_method(shipping_zone_id, shipping_method_id) # @shipping_methods = session.shipping_zones.shipping_methods("8cc24465-3573-4eca-8323-b076bb724080", { size: 20, page: 0 }) # def shipping_methods(shipping_zone_id, params = {}) - response, status = BeyondAPI::Request.get(@session, "/shipping-zones/#{shipping_zone_id}/shipping-methods", params) + response, status = BeyondApi::Request.get(@session, "/shipping-zones/#{shipping_zone_id}/shipping-methods", params) handle_response(response, status) end @@ -262,7 +262,7 @@ def shipping_methods(shipping_zone_id, params = {}) # def sort(shipping_zone_ids) body = shipping_zone_ids.map { |shipping_zone_id| "#{session.api_url}/shipping-zones/#{id}" } - response, status = BeyondAPI::Request.put(@session, "/shipping-zones", body) + response, status = BeyondApi::Request.put(@session, "/shipping-zones", body) handle_response(response, status, respond_with_true: true) end @@ -285,7 +285,7 @@ def sort(shipping_zone_ids) # session.shipping_zones.sort_shipping_methods(shipping_zone_id) # def sort_shipping_methods(shipping_zone_id) - response, status = BeyondAPI::Request.put(@session, "/shipping-zones/#{shipping_zone_id}/shipping-methods") + response, status = BeyondApi::Request.put(@session, "/shipping-zones/#{shipping_zone_id}/shipping-methods") handle_response(response, status) end @@ -316,7 +316,7 @@ def sort_shipping_methods(shipping_zone_id) # @shipping_zone = session.shipping_zones.update("727b3cbf-01b1-442a-bd5c-94c51901f090", body) # def update(shipping_zone_id, body) - response, status = BeyondAPI::Request.put(@session, "/shipping-zones/#{shipping_zone_id}", body) + response, status = BeyondApi::Request.put(@session, "/shipping-zones/#{shipping_zone_id}", body) handle_response(response, status) end diff --git a/lib/beyond_api/resources/shop.rb b/lib/beyond_api/resources/shop.rb index 4de0c08..224e1fe 100644 --- a/lib/beyond_api/resources/shop.rb +++ b/lib/beyond_api/resources/shop.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class Shop < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request is used to retrieve the details of a shop’s address. @@ -20,7 +20,7 @@ class Shop < Base # session.shop.address # def address - response, status = BeyondAPI::Request.get(@session, "/shop/address") + response, status = BeyondApi::Request.get(@session, "/shop/address") handle_response(response, status) end @@ -41,7 +41,7 @@ def address # @shop_attribute = session.shop.attribute("second-unknown-attribute-name") # def attribute(attribute_name) - response, status = BeyondAPI::Request.get(@session, "/shop/attributes/#{attribute_name}") + response, status = BeyondApi::Request.get(@session, "/shop/attributes/#{attribute_name}") handle_response(response, status) end @@ -63,7 +63,7 @@ def attribute(attribute_name) # @shop_attributes = session.shop.attributes(size: 5, page: 1) # def attributes(params = {}) - response, status = BeyondAPI::Request.get(@session, "/shop/attributes", params) + response, status = BeyondApi::Request.get(@session, "/shop/attributes", params) handle_response(response, status) end @@ -83,7 +83,7 @@ def attributes(params = {}) # session.shop.close # def close - response, status = BeyondAPI::Request.post(@session, "/shop/close") + response, status = BeyondApi::Request.post(@session, "/shop/close") handle_response(response, status, respond_with_true: true) end @@ -116,7 +116,7 @@ def close # session.shop.create_attribute(body) # def create_attribute(body) - response, status = BeyondAPI::Request.post(@session, "/shop/attributes", body) + response, status = BeyondApi::Request.post(@session, "/shop/attributes", body) handle_response(response, status) end @@ -148,7 +148,7 @@ def create_attribute(body) # session.shop.create_image(body) # def create_image(body) - response, status = BeyondAPI::Request.post(@session, "/shop/images", body) + response, status = BeyondApi::Request.post(@session, "/shop/images", body) handle_response(response, status, respond_with_true: true) end @@ -165,7 +165,7 @@ def create_image(body) # session.shop.current # def current - response, status = BeyondAPI::Request.get(@session, "/shop") + response, status = BeyondApi::Request.get(@session, "/shop") handle_response(response, status) end @@ -186,7 +186,7 @@ def current # session.shop.delete_attribute("second-unknown-attribute-name") # def delete_attribute(attribute_name) - response, status = BeyondAPI::Request.delete(@session, "/shop/attributes/#{attribute_name}") + response, status = BeyondApi::Request.delete(@session, "/shop/attributes/#{attribute_name}") handle_response(response, status, respond_with_true: true) end @@ -209,7 +209,7 @@ def delete_attribute(attribute_name) # session.shop.delete_image("6a7646dc-7f26-4730-a98f-52f9b63978fb") # def delete_image(image_id) - response, status = BeyondAPI::Request.delete(@session, "/shop/images/#{image_id}") + response, status = BeyondApi::Request.delete(@session, "/shop/images/#{image_id}") handle_response(response, status, respond_with_true: true) end @@ -228,7 +228,7 @@ def delete_image(image_id) # session.shop.image("2feee7ac-f1cb-4faf-9488-f3ce07394141") # def image(image_id) - response, status = BeyondAPI::Request.get(@session, "/shop/images/#{image_id}") + response, status = BeyondApi::Request.get(@session, "/shop/images/#{image_id}") handle_response(response, status) end @@ -248,7 +248,7 @@ def image(image_id) # session.shop.images(size: 5, page: 1) # def images(params = {}) - response, status = BeyondAPI::Request.get(@session, "/shop/images", params) + response, status = BeyondApi::Request.get(@session, "/shop/images", params) handle_response(response, status) end @@ -268,7 +268,7 @@ def images(params = {}) # session.shop.legal_content("right-of-withdrawal") # def legal_content(legal_content_type) - response, status = BeyondAPI::Request.get(@session, "/legal-content/right-of-withdrawal") + response, status = BeyondApi::Request.get(@session, "/legal-content/right-of-withdrawal") handle_response(response, status) end @@ -289,7 +289,7 @@ def legal_content(legal_content_type) # session.shop.legal_contents(size: 5, page: 1) # def legal_contents(params = {}) - response, status = BeyondAPI::Request.get(@session, "/legal-content") + response, status = BeyondApi::Request.get(@session, "/legal-content") handle_response(response, status) end @@ -308,7 +308,7 @@ def legal_contents(params = {}) # session.shop.legal_details # def legal_details - response, status = BeyondAPI::Request.get(@session, "/shop/legal") + response, status = BeyondApi::Request.get(@session, "/shop/legal") handle_response(response, status) end @@ -328,7 +328,7 @@ def legal_details # session.shop.open # def open - response, status = BeyondAPI::Request.post(@session, "/shop/open") + response, status = BeyondApi::Request.post(@session, "/shop/open") handle_response(response, status, respond_with_true: true) end @@ -347,7 +347,7 @@ def open # session.shop.search_images_by_label("logo") # def search_images_by_label(label) - response, status = BeyondAPI::Request.get(@session, "/shop/images/search/find-by-label", { label: label }) + response, status = BeyondApi::Request.get(@session, "/shop/images/search/find-by-label", { label: label }) handle_response(response, status) end @@ -401,7 +401,7 @@ def search_images_by_label(label) # session.shop.update(body) # def update(body) - response, status = BeyondAPI::Request.patch(@session, "/shop") + response, status = BeyondApi::Request.patch(@session, "/shop") handle_response(response, status) end @@ -431,7 +431,7 @@ def update(body) # session.shop.update_address(body) # def update_address(body) - response, status = BeyondAPI::Request.patch(@session, "/shop/address", body) + response, status = BeyondApi::Request.patch(@session, "/shop/address", body) handle_response(response, status) end @@ -463,7 +463,7 @@ def update_address(body) # session.shop.update_attribute("second-unknown-attribute-name", body) # def update_attribute(attribute_name, body) - response, status = BeyondAPI::Request.put(@session, "/shop/attributes/#{attribute_name}", body) + response, status = BeyondApi::Request.put(@session, "/shop/attributes/#{attribute_name}", body) handle_response(response, status) end @@ -489,7 +489,7 @@ def update_attribute(attribute_name, body) # session.shop.update_legal_content(body) # def update_legal_content(body) - response, status = BeyondAPI::Request.put(@session, "/legal-content/legal-notice") + response, status = BeyondApi::Request.put(@session, "/legal-content/legal-notice") handle_response(response, status) end @@ -519,7 +519,7 @@ def update_legal_content(body) # session.shop.update_legal_details(body) # def update_legal_details(body) - response, status = BeyondAPI::Request.patch(@session, "/shop/legal") + response, status = BeyondApi::Request.patch(@session, "/shop/legal") handle_response(response, status) end @@ -553,7 +553,7 @@ def upload_image(image_path, image_name, label) end image_binary = File.binread(image_path) - response, status = BeyondAPI::Request.upload(@session, "/shop/images", image_binary, content_type, { file_name: image_name, label: label }) + response, status = BeyondApi::Request.upload(@session, "/shop/images", image_binary, content_type, { file_name: image_name, label: label }) handle_response(response, status, respond_with_true: true) end diff --git a/lib/beyond_api/resources/token.rb b/lib/beyond_api/resources/token.rb index e55aa2b..3139351 100644 --- a/lib/beyond_api/resources/token.rb +++ b/lib/beyond_api/resources/token.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module BeyondAPI +module BeyondApi class Token class InvalidSessionError < StandardError; end @@ -8,12 +8,12 @@ class InvalidSessionError < StandardError; end def initialize(session) @session = session - raise InvalidSessionError.new("Invalid session") unless session.is_a? BeyondAPI::Session + raise InvalidSessionError.new("Invalid session") unless session.is_a? BeyondApi::Session raise InvalidSessionError.new("Session api_url cannot be nil") if session.api_url.nil? end def create(code) - response, status = BeyondAPI::Request.token(@session.api_url + "/oauth/token", + response, status = BeyondApi::Request.token(@session.api_url + "/oauth/token", grant_type: "authorization_code", code: code) @@ -21,12 +21,12 @@ def create(code) @session.access_token = response["access_token"] @session.refresh_token = response["refresh_token"] else - BeyondAPI::Error.new(response) + BeyondApi::Error.new(response) end end def refresh - response, status = BeyondAPI::Request.token(@session.api_url + "/oauth/token", + response, status = BeyondApi::Request.token(@session.api_url + "/oauth/token", grant_type: "refresh_token", refresh_token: @session.refresh_token) @@ -34,7 +34,7 @@ def refresh @session.access_token = response["access_token"] @session.refresh_token = response["refresh_token"] else - BeyondAPI::Error.new(response) + BeyondApi::Error.new(response) end end end diff --git a/lib/beyond_api/resources/users.rb b/lib/beyond_api/resources/users.rb index dfaf2f8..2fac24e 100644 --- a/lib/beyond_api/resources/users.rb +++ b/lib/beyond_api/resources/users.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class Users < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +POST+ request is used to add the roles of a user. @@ -25,7 +25,7 @@ class Users < Base # session.users.add_roles(user_id, body) # def add_roles(user_id, body) - response, status = BeyondAPI::Request.post(@session, "/users/#{user_id}/roles", body) + response, status = BeyondApi::Request.post(@session, "/users/#{user_id}/roles", body) handle_response(response, status, respond_with_true: true) end @@ -49,7 +49,7 @@ def add_roles(user_id, body) # session.users.all(params = {}) # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/users") + response, status = BeyondApi::Request.get(@session, "/users") handle_response(response, status) end @@ -78,7 +78,7 @@ def all(params = {}) # session.users.change_password(user_id, current_password, new_password) # def change_password(user_id, current_password, new_password) - response, status = BeyondAPI::Request.post(@session, "/users/#{user_id}/change-password", current_password: current_password, new_password: new_password) + response, status = BeyondApi::Request.post(@session, "/users/#{user_id}/change-password", current_password: current_password, new_password: new_password) handle_response(response, status) end @@ -107,7 +107,7 @@ def change_password(user_id, current_password, new_password) # session.users.change_username(user_id, new_username, current_password) # def change_username(user_id, new_username, current_password) - response, status = BeyondAPI::Request.post(@session, "/users/#{user_id}/change-username", new_username: new_username, current_password: current_password) + response, status = BeyondApi::Request.post(@session, "/users/#{user_id}/change-username", new_username: new_username, current_password: current_password) handle_response(response, status) end @@ -135,7 +135,7 @@ def change_username(user_id, new_username, current_password) # session.users.create(body) # def create(body) - response, status = BeyondAPI::Request.post(@session, "/users", body) + response, status = BeyondApi::Request.post(@session, "/users", body) handle_response(response, status) end @@ -156,7 +156,7 @@ def create(body) # session.users.enable_support_access # def enable_support_access - response, status = BeyondAPI::Request.post(@session, "/users/support") + response, status = BeyondApi::Request.post(@session, "/users/support") handle_response(response, status, respond_with_true: true) end @@ -177,7 +177,7 @@ def enable_support_access # session.users.disable_support_access # def disable_support_access - response, status = BeyondAPI::Request.delete(@session, "/users/support") + response, status = BeyondApi::Request.delete(@session, "/users/support") handle_response(response, status, respond_with_true: true) end @@ -200,7 +200,7 @@ def disable_support_access # session.users.find(user_id) # def find(user_id) - response, status = BeyondAPI::Request.get(@session, "/users/#{user_id}") + response, status = BeyondApi::Request.get(@session, "/users/#{user_id}") handle_response(response, status) end @@ -221,7 +221,7 @@ def find(user_id) # session.users.roles(user_id) # def roles(user_id) - response, status = BeyondAPI::Request.get(@session, "/users/#{user_id}/roles") + response, status = BeyondApi::Request.get(@session, "/users/#{user_id}/roles") handle_response(response, status) end @@ -243,7 +243,7 @@ def roles(user_id) # session.users.search_by_username(username) # def search_by_username(username) - response, status = BeyondAPI::Request.get(@session, "/users/search/find-by-username", username: username) + response, status = BeyondApi::Request.get(@session, "/users/search/find-by-username", username: username) handle_response(response, status) end @@ -273,7 +273,7 @@ def search_by_username(username) # session.users.send_email_address_change(user_id, new_email, current_password, locale) # def send_email_address_change(user_id, new_email, current_password, locale) - response, status = BeyondAPI::Request.post(@session, "/users/#{user_id}/change-email-request", { new_email: new_email, current_password: current_password }, { locale: locale }) + response, status = BeyondApi::Request.post(@session, "/users/#{user_id}/change-email-request", { new_email: new_email, current_password: current_password }, { locale: locale }) handle_response(response, status, respond_with_true: true) end @@ -299,7 +299,7 @@ def send_email_address_change(user_id, new_email, current_password, locale) # session.users.send_reset_password_email(email, locale) # def send_reset_password_email(email, locale) - response, status = BeyondAPI::Request.post(@session, "/users/reset-password-request", { email: email }, { locale: locale }) + response, status = BeyondApi::Request.post(@session, "/users/reset-password-request", { email: email }, { locale: locale }) handle_response(response, status, respond_with_true: true) end @@ -323,7 +323,7 @@ def send_reset_password_email(email, locale) # session.users.set_roles(user_id, body) # def set_roles(user_id, body) - response, status = BeyondAPI::Request.put(@session, "/users/#{user_id}/roles", body) + response, status = BeyondApi::Request.put(@session, "/users/#{user_id}/roles", body) handle_response(response, status, respond_with_true: true) end @@ -343,7 +343,7 @@ def set_roles(user_id, body) # session.users.support_access # def support_access - response, status = BeyondAPI::Request.get(@session, "/users/support") + response, status = BeyondApi::Request.get(@session, "/users/support") handle_response(response, status) end @@ -368,7 +368,7 @@ def support_access # session.users.verify_password(password) # def verify_password(password) - response, status = BeyondAPI::Request.post(@session, "/users/verify-password", password: password) + response, status = BeyondApi::Request.post(@session, "/users/verify-password", password: password) handle_response(response, status, respond_with_true: true) end diff --git a/lib/beyond_api/resources/variations.rb b/lib/beyond_api/resources/variations.rb index a201613..b88aeeb 100644 --- a/lib/beyond_api/resources/variations.rb +++ b/lib/beyond_api/resources/variations.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class Variations < Base - include BeyondAPI::Utils + include BeyondApi::Utils # # A +GET+ request is used to retrieve the variations of a product. @@ -24,7 +24,7 @@ class Variations < Base # @products = session.variations.all(size: 100, page: 0) # def all(product_id, params = {}) - response, status = BeyondAPI::Request.get(@session, "/products/#{product_id}/variations", params) + response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variations", params) handle_response(response, status) end @@ -48,7 +48,7 @@ def all(product_id, params = {}) # @product = session.variations.find("f461fb56-1984-4ade-bd4e-007c273cc923", "f6e5bb16-af2e-440f-acd3-a883ad3c1922") # def find(product_id, variation_id) - response, status = BeyondAPI::Request.get(@session, "/products/#{product_id}/variations/#{variation_id}") + response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variations/#{variation_id}") handle_response(response, status) end @@ -137,7 +137,7 @@ def find(product_id, variation_id) # @product = session.variations.update("f461fb56-1984-4ade-bd4e-007c273cc923", "f6e5bb16-af2e-440f-acd3-a883ad3c1922", body) # def update(product_id, variation_id, body) - response, status = BeyondAPI::Request.patch(@session, "/products/#{product_id}/variations/#{variation_id}", body) + response, status = BeyondApi::Request.patch(@session, "/products/#{product_id}/variations/#{variation_id}", body) handle_response(response, status) end diff --git a/lib/beyond_api/resources/variations/availability.rb b/lib/beyond_api/resources/variations/availability.rb index 8cf392d..b22bd4e 100644 --- a/lib/beyond_api/resources/variations/availability.rb +++ b/lib/beyond_api/resources/variations/availability.rb @@ -2,7 +2,7 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi module VariationAvailability # @@ -26,7 +26,7 @@ module VariationAvailability # @availability = session.variations.adjust_stock_level(product_id, variation_id, { relativeAmount => -1 }) # def adjust_stock_level(product_id, variation_id, body) - response, status = BeyondAPI::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/enable-stock-management", body) + response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/enable-stock-management", body) handle_response(response, status) end @@ -50,7 +50,7 @@ def adjust_stock_level(product_id, variation_id, body) # @availability = session.variations.availability("fb22d408-00dc-47e3-ae58-e35769bdb428", "13b28149-975a-4f47-ad54-bdc4ca4a07ec") # def availability(product_id, variation_id) - response, status = BeyondAPI::Request.get(@session, "/products/#{product_id}/variations/#{variation_id}/availability") + response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variations/#{variation_id}/availability") handle_response(response, status) end @@ -74,7 +74,7 @@ def availability(product_id, variation_id) # @availability = session.variations.enable_purchaability("1e3a92b-6f3b-4415-bd8f-c9c8921a5a73", "13b28149-975a-4f47-ad54-bdc4ca4a07ec") # def enable_purchasability(product_id, variation_id) - response, status = BeyondAPI::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/enable-purchasability") + response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/enable-purchasability") handle_response(response, status) end @@ -97,7 +97,7 @@ def enable_purchasability(product_id, variation_id) # @availability = session.variations.disable_purchasability("17e3a92b-6f3b-4415-bd8f-c9c8921a5a73", "13b28149-975a-4f47-ad54-bdc4ca4a07ec") # def disable_purchasability(product_id, variation_id) - response, status = BeyondAPI::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/disable-purchasability") + response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/disable-purchasability") handle_response(response, status) end diff --git a/lib/beyond_api/resources/webhook_subscriptions.rb b/lib/beyond_api/resources/webhook_subscriptions.rb index 27e3c64..ed26961 100644 --- a/lib/beyond_api/resources/webhook_subscriptions.rb +++ b/lib/beyond_api/resources/webhook_subscriptions.rb @@ -2,9 +2,9 @@ require "beyond_api/utils" -module BeyondAPI +module BeyondApi class WebhookSuscriptions < Base # :category: Resources - include BeyondAPI::Utils + include BeyondApi::Utils # # A +POST+ request is used to activate a webhook subscription. @@ -22,7 +22,7 @@ class WebhookSuscriptions < Base # :category: Resources # session.webhook_subscriptions.activate("268a8629-55cd-4890-9013-936b9b5ea14c") # def activate(webhook_subscription_id) - response, status = BeyondAPI::Request.post(@session, "/webhook-subscriptions/#{webhook_subscription_id}/activate") + response, status = BeyondApi::Request.post(@session, "/webhook-subscriptions/#{webhook_subscription_id}/activate") handle_response(response, status, respond_with_true: true) end @@ -43,7 +43,7 @@ def activate(webhook_subscription_id) # @webhook_subscriptions = session.webhook_subscriptions.all(size: 100, page: 0) # def all(params = {}) - response, status = BeyondAPI::Request.get(@session, "/webhook-subscriptions", params) + response, status = BeyondApi::Request.get(@session, "/webhook-subscriptions", params) handle_response(response, status) end @@ -75,7 +75,7 @@ def all(params = {}) # @webhook_subscription = session.webhook_subscriptions.create(body) # def create(body) - response, status = BeyondAPI::Request.post(@session, "/webhook-subscriptions", body) + response, status = BeyondApi::Request.post(@session, "/webhook-subscriptions", body) handle_response(response, status) end @@ -94,7 +94,7 @@ def create(body) # session.webhook_subscriptions.deactivate("a597cea4-b688-4164-8c56-b6568ea4d5aa") # def deactivate(webhook_subscription_id) - response, status = BeyondAPI::Request.post(@session, "/webhook-subscriptions/#{webhook_subscription_id}/deactivate") + response, status = BeyondApi::Request.post(@session, "/webhook-subscriptions/#{webhook_subscription_id}/deactivate") handle_response(response, status, respond_with_true: true) end @@ -113,7 +113,7 @@ def deactivate(webhook_subscription_id) # webhook_subscriptions = session.webhook_subscriptions.delete("c6076a5a-a8ad-443f-b20b-8a1b268b069e") # def delete(webhook_subscription_id) - response, status = BeyondAPI::Request.delete(@session, "/webhook-subscriptions/#{webhook_subscription_id}") + response, status = BeyondApi::Request.delete(@session, "/webhook-subscriptions/#{webhook_subscription_id}") handle_response(response, status, respond_with_true: true) end @@ -133,7 +133,7 @@ def delete(webhook_subscription_id) # @webhook_subscription = session.webhook_subscriptions.find("3d44ec71-768c-4927-9069-a96a5153e87c") # def find(webhook_subscription_id) - response, status = BeyondAPI::Request.get(@session, "/webhook-subscriptions/#{webhook_subscription_id}") + response, status = BeyondApi::Request.get(@session, "/webhook-subscriptions/#{webhook_subscription_id}") handle_response(response, status) end @@ -168,7 +168,7 @@ def find(webhook_subscription_id) # @webhook_subscription = session.webhook_subscriptions.update("6f3bc033-c2d1-4f44-80e3-1b668f6bd699", body) # def update(webhook_subscription_id, body) - response, status = BeyondAPI::Request.put(@session, "/webhook-subscriptions/#{webhook_subscription_id}", body) + response, status = BeyondApi::Request.put(@session, "/webhook-subscriptions/#{webhook_subscription_id}", body) handle_response(response, status) end diff --git a/lib/beyond_api/session.rb b/lib/beyond_api/session.rb index 020d273..d128c1a 100644 --- a/lib/beyond_api/session.rb +++ b/lib/beyond_api/session.rb @@ -22,7 +22,7 @@ require "beyond_api/resources/variations" require "beyond_api/resources/webhook_subscriptions" -module BeyondAPI +module BeyondApi class Session attr_reader :api_url attr_accessor :access_token, :refresh_token @@ -34,83 +34,83 @@ def initialize(api_url:, access_token: nil, refresh_token: nil) end def carts - BeyondAPI::Carts.new(self) + BeyondApi::Carts.new(self) end def categories_view - BeyondAPI::CategoriesView.new(self) + BeyondApi::CategoriesView.new(self) end def categories - BeyondAPI::Categories.new(self) + BeyondApi::Categories.new(self) end def checkout_settings - BeyondAPI::CheckoutSettings.new(self) + BeyondApi::CheckoutSettings.new(self) end def newsletter_target - BeyondAPI::NewsletterTarget.new(self) + BeyondApi::NewsletterTarget.new(self) end def order_settings - BeyondAPI::OrderSettings.new(self) + BeyondApi::OrderSettings.new(self) end def orders - BeyondAPI::Orders.new(self) + BeyondApi::Orders.new(self) end def payment_methods - BeyondAPI::PaymentMethods.new(self) + BeyondApi::PaymentMethods.new(self) end def product_attribute_definitions - BeyondAPI::ProductAttributeDefinitions.new(self) + BeyondApi::ProductAttributeDefinitions.new(self) end def product_settings - BeyondAPI::ProductSettings.new(self) + BeyondApi::ProductSettings.new(self) end def products_view - BeyondAPI::ProductsView.new(self) + BeyondApi::ProductsView.new(self) end def products - BeyondAPI::Products.new(self) + BeyondApi::Products.new(self) end def scopes - BeyondAPI::Scopes.new(self) + BeyondApi::Scopes.new(self) end def script_tags - BeyondAPI::ScriptTags.new(self) + BeyondApi::ScriptTags.new(self) end def shipping_zones - BeyondAPI::ShippingZones.new(self) + BeyondApi::ShippingZones.new(self) end def shop - BeyondAPI::Shop.new(self) + BeyondApi::Shop.new(self) end def token - BeyondAPI::Token.new(self) + BeyondApi::Token.new(self) end def users - BeyondAPI::Users.new(self) + BeyondApi::Users.new(self) end def variations - BeyondAPI::Variations.new(self) + BeyondApi::Variations.new(self) end def webhook_subscriptions - BeyondAPI::WebhookSubscriptions.new(self) + BeyondApi::WebhookSubscriptions.new(self) end end end diff --git a/lib/beyond_api/utils.rb b/lib/beyond_api/utils.rb index 7b86722..fb867f3 100644 --- a/lib/beyond_api/utils.rb +++ b/lib/beyond_api/utils.rb @@ -1,18 +1,16 @@ # frozen_string_literal: true -module BeyondAPI +module BeyondApi module Utils extend self def handle_response(response, status, respond_with_true: false) if status.between?(200, 299) return true if respond_with_true - response = sanitize_response(response) - - BeyondAPI.configuration.object_struct_responses ? to_object_struct(response) : response + BeyondApi.configuration.object_struct_responses ? to_object_struct(response) : response else - BeyondAPI::Error.new(response) + BeyondApi::Error.new(response) end end diff --git a/lib/beyond_api/version.rb b/lib/beyond_api/version.rb index 5ecf318..ad962ca 100644 --- a/lib/beyond_api/version.rb +++ b/lib/beyond_api/version.rb @@ -1,3 +1,3 @@ -module BeyondAPI +module BeyondApi VERSION = "0.1.0" end diff --git a/lib/generators/beyond_api/install_generator.rb b/lib/generators/beyond_api/install_generator.rb index ddd1e7e..bfdc27c 100644 --- a/lib/generators/beyond_api/install_generator.rb +++ b/lib/generators/beyond_api/install_generator.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -module BeyondAPI +module BeyondApi module Generators class InstallGenerator < Rails::Generators::Base source_root File.expand_path("../../templates", __FILE__) diff --git a/lib/generators/templates/beyond_initializer.rb b/lib/generators/templates/beyond_api_initializer.rb similarity index 95% rename from lib/generators/templates/beyond_initializer.rb rename to lib/generators/templates/beyond_api_initializer.rb index d3d6c43..2d74988 100644 --- a/lib/generators/templates/beyond_initializer.rb +++ b/lib/generators/templates/beyond_api_initializer.rb @@ -1,11 +1,11 @@ # frozen_string_literal: true -BeyondAPI.setup do |config| +BeyondApi.setup do |config| # ==> Client configuration config.client_id = nil config.client_secret = nil - # ==> API configuration + # ==> Api configuration # Configure the open connection timeout in seconds. Default is 2 seconds. # config.open_timeout = 2.seconds diff --git a/spec/beyond_api/resources/carts_spec.rb b/spec/beyond_api/resources/carts_spec.rb index 805b80d..0431f44 100644 --- a/spec/beyond_api/resources/carts_spec.rb +++ b/spec/beyond_api/resources/carts_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::Carts do +RSpec.describe BeyondApi::Carts do describe "#create" do it "returns a Hash on successful request" end diff --git a/spec/beyond_api/resources/categories_spec.rb b/spec/beyond_api/resources/categories_spec.rb index 95095ab..b9ec5f9 100644 --- a/spec/beyond_api/resources/categories_spec.rb +++ b/spec/beyond_api/resources/categories_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::Categories do +RSpec.describe BeyondApi::Categories do describe "#all" do it "returns a Hash on successful request" end diff --git a/spec/beyond_api/resources/categories_view_spec.rb b/spec/beyond_api/resources/categories_view_spec.rb index 4d82ae9..f57f7aa 100644 --- a/spec/beyond_api/resources/categories_view_spec.rb +++ b/spec/beyond_api/resources/categories_view_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::CategoriesView do +RSpec.describe BeyondApi::CategoriesView do describe "#all" do it "returns a Hash on successful request" end diff --git a/spec/beyond_api/resources/checkout_settings_spec.rb b/spec/beyond_api/resources/checkout_settings_spec.rb index 6aa3780..84b76fd 100644 --- a/spec/beyond_api/resources/checkout_settings_spec.rb +++ b/spec/beyond_api/resources/checkout_settings_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::CheckoutSettings do +RSpec.describe BeyondApi::CheckoutSettings do describe "#all" do it "returns a Hash on successful request" end diff --git a/spec/beyond_api/resources/newsletter_target_spec.rb b/spec/beyond_api/resources/newsletter_target_spec.rb index 60f35e6..fd528f4 100644 --- a/spec/beyond_api/resources/newsletter_target_spec.rb +++ b/spec/beyond_api/resources/newsletter_target_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::NewsletterTarget do +RSpec.describe BeyondApi::NewsletterTarget do describe "#create" do it "returns a Hash on successful request" do expect(@session.categories.all).to be_a Hash diff --git a/spec/beyond_api/resources/order_settings_spec.rb b/spec/beyond_api/resources/order_settings_spec.rb index 39a38f5..b7fe454 100644 --- a/spec/beyond_api/resources/order_settings_spec.rb +++ b/spec/beyond_api/resources/order_settings_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::OrderSettings do +RSpec.describe BeyondApi::OrderSettings do describe "#all" do it "returns a Hash on successful request" end diff --git a/spec/beyond_api/resources/orders_spec.rb b/spec/beyond_api/resources/orders_spec.rb index 1b9c4c2..4b88a19 100644 --- a/spec/beyond_api/resources/orders_spec.rb +++ b/spec/beyond_api/resources/orders_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::Orders do +RSpec.describe BeyondApi::Orders do describe "#active_payment_process" do it "returns a Hash on successful request" end diff --git a/spec/beyond_api/resources/payment_methods_spec.rb b/spec/beyond_api/resources/payment_methods_spec.rb index 6bda6ba..d985e36 100644 --- a/spec/beyond_api/resources/payment_methods_spec.rb +++ b/spec/beyond_api/resources/payment_methods_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::PaymentMethods do +RSpec.describe BeyondApi::PaymentMethods do describe "#activate" do it "returns a true on successful request" end diff --git a/spec/beyond_api/resources/product_attribute_definitions_spec.rb b/spec/beyond_api/resources/product_attribute_definitions_spec.rb index d448b2b..6f7ebab 100644 --- a/spec/beyond_api/resources/product_attribute_definitions_spec.rb +++ b/spec/beyond_api/resources/product_attribute_definitions_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::ProductAttributeDefinitions do +RSpec.describe BeyondApi::ProductAttributeDefinitions do describe "#all" do it "returns a Hash on successful request" end diff --git a/spec/beyond_api/resources/products_view_spec.rb b/spec/beyond_api/resources/products_view_spec.rb index 277045f..ab80a8c 100644 --- a/spec/beyond_api/resources/products_view_spec.rb +++ b/spec/beyond_api/resources/products_view_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::ProductsView do +RSpec.describe BeyondApi::ProductsView do describe "#all" do it "returns a Hash on successful request" end diff --git a/spec/beyond_api/resources/scopes_spec.rb b/spec/beyond_api/resources/scopes_spec.rb index ccf68ec..3291841 100644 --- a/spec/beyond_api/resources/scopes_spec.rb +++ b/spec/beyond_api/resources/scopes_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::Scopes do +RSpec.describe BeyondApi::Scopes do describe "#all" do it "returns a Hash on successful request" end diff --git a/spec/beyond_api/resources/script_tags_spec.rb b/spec/beyond_api/resources/script_tags_spec.rb index 22fe68e..35f4c58 100644 --- a/spec/beyond_api/resources/script_tags_spec.rb +++ b/spec/beyond_api/resources/script_tags_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::ScriptTags do +RSpec.describe BeyondApi::ScriptTags do describe "#all" do it "returns a Hash on successful request" end diff --git a/spec/beyond_api/resources/shipping_zones_spec.rb b/spec/beyond_api/resources/shipping_zones_spec.rb index 25fd9b3..094f96f 100644 --- a/spec/beyond_api/resources/shipping_zones_spec.rb +++ b/spec/beyond_api/resources/shipping_zones_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::ShippingZones do +RSpec.describe BeyondApi::ShippingZones do describe "#all" do it "returns a Hash on successful request" end diff --git a/spec/beyond_api/resources/shop_spec.rb b/spec/beyond_api/resources/shop_spec.rb index ab613f6..e3a6cb0 100644 --- a/spec/beyond_api/resources/shop_spec.rb +++ b/spec/beyond_api/resources/shop_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::Shop do +RSpec.describe BeyondApi::Shop do describe "#address" do it "returns a Hash on successful request" do expect(@session.shop.address).to be_a Hash diff --git a/spec/beyond_api/resources/users_spec.rb b/spec/beyond_api/resources/users_spec.rb index 2e475cd..62dafbf 100644 --- a/spec/beyond_api/resources/users_spec.rb +++ b/spec/beyond_api/resources/users_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::Users do +RSpec.describe BeyondApi::Users do before(:all) do @password = Faker::Internet.password(min_length: 8, special_characters: true) @user = @session.users.create({ email: Faker::Internet.email, diff --git a/spec/beyond_api/resources/webhook_suscriptions_spec.rb b/spec/beyond_api/resources/webhook_suscriptions_spec.rb index 519f111..c6f31da 100644 --- a/spec/beyond_api/resources/webhook_suscriptions_spec.rb +++ b/spec/beyond_api/resources/webhook_suscriptions_spec.rb @@ -2,7 +2,7 @@ require "spec_helper" -RSpec.describe BeyondAPI::WebhookSuscriptions do +RSpec.describe BeyondApi::WebhookSuscriptions do describe "activate" do it "returns a Hash on successful request" end diff --git a/spec/beyond_api_spec.rb b/spec/beyond_api_spec.rb index 0bd7bab..71fe28e 100644 --- a/spec/beyond_api_spec.rb +++ b/spec/beyond_api_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true -RSpec.describe BeyondAPI do +RSpec.describe BeyondApi do it "has a version number" do - expect(BeyondAPI::VERSION).not_to be nil + expect(BeyondApi::VERSION).not_to be nil end end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 71012d5..ef52314 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -16,14 +16,14 @@ c.syntax = :expect end - # Initialize BeyondAPI + # Initialize BeyondApi config.before(:all) do - BeyondAPI.setup do |config| + BeyondApi.setup do |config| config.client_id = ENV["CLIENT_ID"] config.client_secret = ENV["CLIENT_SECRET"] end - @session = BeyondAPI::Session.new(api_url: ENV["API_URL"], + @session = BeyondApi::Session.new(api_url: ENV["Api_URL"], access_token: ENV["ACCESS_TOKEN"], refresh_token: ENV["REFRESH_TOKEN"]) @session.token.refresh