beyond_api 0.8.1.pre → 0.12.0.pre

data/lib/beyond_api/resources/shops/locations.rb

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  module ShopLocations
+
+    #
+    # A +GET+ request is used to retrieve a list of all locations for the current shop.
+    #
+    #   $ curl 'https://yourshop.api.urn/shop/locations' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +loca:r+
+    #
+    # @option params [Boolean] :paginated
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @locations = session.shop.locations(size: 100, page: 0)
+    #
+    def locations(params = {})
+      handle_all_request("/shop/locations", :locations, params)
+    end
+
+    #
+    # A +POST+ request is used to create a location.
+    #
+    #   $ curl 'https://yourshop.api.urn/shop/locations' -i -X POST \
+    #       -H 'Content-Type: application/json;charset=UTF-8' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "languageCode" : "de",
+    #     "storeCode" : "",
+    #     "locationName" : "HealthyThings",
+    #     "primaryPhone" : "01522 3097093",
+    #     "address" : {
+    #       "locality" : "Hamburg",
+    #       "postalCode" : "20253",
+    #       "regionCode" : "DE",
+    #       "addressLines" : [ "Pilatuspool 2", "ePages GmbH" ]
+    #     },
+    #     "primaryCategory" : {
+    #       "categoryId" : "gcid:store",
+    #       "displayName" : "Geschaeft"
+    #     },
+    #     "websiteUrl" : "",
+    #     "regularHours" : {
+    #       "periods" : [ {
+    #         "openDay" : "MONDAY",
+    #         "openTime" : "18:00",
+    #         "closeDay" : "TUESDAY",
+    #         "closeTime" : "03:00"
+    #       }, {
+    #         "openDay" : "WEDNESDAY",
+    #         "openTime" : "17:00",
+    #         "closeDay" : "WEDNESDAY",
+    #         "closeTime" : "23:00"
+    #       } ]
+    #     },
+    #     "latLng" : {
+    #       "latitude" : 53.5847424,
+    #       "longitude" : 9.968901
+    #     }
+    #   }'
+    #
+    # @beyond_api.scopes +loca:c+
+    #
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "languageCode" => "de",
+    #     "storeCode" => "",
+    #     "locationName" => "HealthyThings",
+    #     "primaryPhone" => "01522 3097093",
+    #     "address" => {
+    #       "locality" => "Hamburg",
+    #       "postalCode" => "20253",
+    #       "regionCode" => "DE",
+    #       "addressLines" => [ "Pilatuspool 2", "ePages GmbH" ]
+    #     },
+    #     "primaryCategory" => {
+    #       "categoryId" => "gcid:store",
+    #       "displayName" => "Geschaeft"
+    #     },
+    #     "websiteUrl" => "",
+    #     "regularHours" => {
+    #       "periods" => [ {
+    #         "openDay" => "MONDAY",
+    #         "openTime" => "18:00",
+    #         "closeDay" => "TUESDAY",
+    #         "closeTime" => "03:00"
+    #       }, {
+    #         "openDay" => "WEDNESDAY",
+    #         "openTime" => "17:00",
+    #         "closeDay" => "WEDNESDAY",
+    #         "closeTime" => "23:00"
+    #       } ]
+    #     },
+    #     "latLng" : {
+    #       "latitude" => 53.5847424,
+    #       "longitude" => 9.968901
+    #     }
+    #   }
+    #   @location = session.shop.create_location(body)
+    #
+    def create_location(body)
+      response, status = BeyondApi::Request.post(@session, "/shop/locations", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +DELETE+ request is used to delete a location.
+    #
+    #   $ curl 'https://yourshop.api.urn/shop/locations/5bcf7c0a-d130-4cf8-af0c-5e57d4605be0' -i -X DELETE \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +loca:d+
+    #
+    # @param location_id [String] the location UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.shop.delete_location("f461fb56-1984-4ade-bd4e-007c273cc923")
+    #
+    def delete_location(location_id)
+      response, status = BeyondApi::Request.delete(@session, "/shop/locations/#{location_id}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +GET+ request is used to retrieve a particular location by its id.
+    #
+    #   $ curl 'https://yourshop.api.urn/shop/locations/09ca2715-cdf7-4af3-8b22-9ecf39d1e202' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +loca:r+
+    #
+    # @param location_id [String] the location UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @location = session.shop.location("27a94b71-9b17-4f06-9596-fbbf4d18021f")
+    #
+    def location(location_id)
+      response, status = BeyondApi::Request.get(@session, "/shop/locations/#{location_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PUT+ request is used to update a location.
+    #
+    #   $ curl 'https://yourshop.api.urn/shop/locations/a7a2acfa-0243-4e52-8b56-81cb781ce61d' -i -X PUT \
+    #       -H 'Content-Type: application/json;charset=UTF-8' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "languageCode" : "en",
+    #     "storeCode" : "",
+    #     "locationName" : "UnhealthyThings",
+    #     "primaryPhone" : "01234 691997",
+    #     "address" : {
+    #       "locality" : "London",
+    #       "postalCode" : "1",
+    #       "regionCode" : "GB",
+    #       "addressLines" : [ "St. James Square", "ePages Ltd" ]
+    #     },
+    #     "primaryCategory" : {
+    #       "categoryId" : "gcid:store",
+    #       "displayName" : "Shop"
+    #     },
+    #     "websiteUrl" : "",
+    #     "regularHours" : {
+    #       "periods" : [ {
+    #         "openDay" : "SATURDAY",
+    #         "openTime" : "06:00",
+    #         "closeDay" : "SATURDAY",
+    #         "closeTime" : "22:00"
+    #       } ]
+    #     },
+    #     "latLng" : {
+    #       "latitude" : 51.5072,
+    #       "longitude" : -0.1353
+    #     }
+    #   }'
+    #
+    # @beyond_api.scopes +loca:u+
+    #
+    # @param location_id [String] the location UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "languageCode" => "de",
+    #     "storeCode" => "",
+    #     "locationName" => "HealthyThings",
+    #     "primaryPhone" => "01522 3097093",
+    #     "address" => {
+    #       "locality" => "Hamburg",
+    #       "postalCode" => "20253",
+    #       "regionCode" => "DE",
+    #       "addressLines" => [ "Pilatuspool 2", "ePages GmbH" ]
+    #     },
+    #     "primaryCategory" => {
+    #       "categoryId" => "gcid:store",
+    #       "displayName" => "Geschaeft"
+    #     },
+    #     "websiteUrl" => "",
+    #     "regularHours" => {
+    #       "periods" => [ {
+    #         "openDay" => "MONDAY",
+    #         "openTime" => "18:00",
+    #         "closeDay" => "TUESDAY",
+    #         "closeTime" => "03:00"
+    #       }, {
+    #         "openDay" => "WEDNESDAY",
+    #         "openTime" => "17:00",
+    #         "closeDay" => "WEDNESDAY",
+    #         "closeTime" => "23:00"
+    #       } ]
+    #     },
+    #     "latLng" : {
+    #       "latitude" => 53.5847424,
+    #       "longitude" => 9.968901
+    #     }
+    #   }
+    #   @location = session.shop.update_location("27a94b71-9b17-4f06-9596-fbbf4d18021f", body)
+    #
+    def update_location(location_id, body)
+      response, status = BeyondApi::Request.put(@session, "/shop/locations/#{location_id}", body)
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/resources/token.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+require "beyond_api/utils"
+
 module BeyondApi
   class Token
     class InvalidSessionError < StandardError; end
 
+    include BeyondApi::Utils
+
     attr_reader :session
 
     def initialize(session)
@@ -44,7 +48,7 @@ module BeyondApi
         @session.refresh_token = response["refresh_token"]
         @session
       else
-        BeyondApi::Error.new(response)
+        handle_error(response, status)
       end
     end
   end

data/lib/beyond_api/resources/users.rb

@@ -40,6 +40,7 @@ module BeyondApi
     #
     # @beyond_api.scopes +user:r+
     #
+    # @option params [Boolean] :paginated
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
     #
@@ -49,9 +50,7 @@ module BeyondApi
     #   @users = session.users.all(size: 100, page: 0)
     #
     def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/users")
-
-      handle_response(response, status)
+      handle_all_request("/users", :users, params)
     end
 
     #

data/lib/beyond_api/resources/variations.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require "beyond_api/utils"
-require "beyond_api/resources/variations/images"
-require "beyond_api/resources/variations/availability"
 
 module BeyondApi
+  autoload :Images,       "beyond_api/resources/variations/images"
+  autoload :Availability, "beyond_api/resources/variations/availability"
+
   class Variations < Base
     include BeyondApi::VariationImages
     include BeyondApi::VariationAvailability

data/lib/beyond_api/resources/webhook_subscriptions.rb

@@ -34,6 +34,7 @@ module BeyondApi
     #       -H 'Accept: application/hal+json' \
     #       -H 'Authorization: Bearer <Access token>'
     #
+    # @option params [Boolean] :paginated
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
     #
@@ -43,9 +44,7 @@ module BeyondApi
     #   @webhook_subscriptions = session.webhook_subscriptions.all(size: 100, page: 0)
     #
     def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/webhook-subscriptions", params)
-
-      handle_response(response, status)
+      handle_all_request("/webhook-subscriptions", :webhook_subscriptions, params)
     end
 
     #

data/lib/beyond_api/session.rb

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
 
-require "beyond_api/resources/base"
-require "beyond_api/resources/carts"
-require "beyond_api/resources/categories_view"
-require "beyond_api/resources/categories"
-require "beyond_api/resources/checkout_settings"
-require "beyond_api/resources/customers"
-require "beyond_api/resources/newsletter_target"
-require "beyond_api/resources/order_settings"
-require "beyond_api/resources/orders"
-require "beyond_api/resources/payment_methods"
-require "beyond_api/resources/product_attribute_definitions"
-require "beyond_api/resources/products_view"
-require "beyond_api/resources/products"
-require "beyond_api/resources/script_tags"
-require "beyond_api/resources/shipping_zones"
-require "beyond_api/resources/shop"
-require "beyond_api/resources/signers"
-require "beyond_api/resources/token"
-require "beyond_api/resources/users"
-require "beyond_api/resources/variations"
-require "beyond_api/resources/webhook_subscriptions"
-
 module BeyondApi
+  autoload :Base,                        "beyond_api/resources/base"
+  autoload :Carts,                       "beyond_api/resources/carts"
+  autoload :CategoriesView,              "beyond_api/resources/categories_view"
+  autoload :Categories,                  "beyond_api/resources/categories"
+  autoload :CheckoutSettings,            "beyond_api/resources/checkout_settings"
+  autoload :Customers,                   "beyond_api/resources/customers"
+  autoload :NewsletterTarget,            "beyond_api/resources/newsletter_target"
+  autoload :OrderSettings,               "beyond_api/resources/order_settings"
+  autoload :Orders,                      "beyond_api/resources/orders"
+  autoload :PaymentMethods,              "beyond_api/resources/payment_methods"
+  autoload :ProductAttributeDefinitions, "beyond_api/resources/product_attribute_definitions"
+  autoload :ProductsView,                "beyond_api/resources/products_view"
+  autoload :Products,                    "beyond_api/resources/products"
+  autoload :ScriptTags,                  "beyond_api/resources/script_tags"
+  autoload :ShippingZones,               "beyond_api/resources/shipping_zones"
+  autoload :Shop,                        "beyond_api/resources/shop"
+  autoload :Signers,                     "beyond_api/resources/signers"
+  autoload :Token,                       "beyond_api/resources/token"
+  autoload :Users,                       "beyond_api/resources/users"
+  autoload :Variations,                  "beyond_api/resources/variations"
+  autoload :WebhookSubscriptions,        "beyond_api/resources/webhook_subscriptions"
+
   class Session
     attr_reader :api_url
     attr_accessor :access_token, :refresh_token

data/lib/beyond_api/utils.rb

@@ -10,11 +10,16 @@ module BeyondApi
         response = sanitize_response(response)
         BeyondApi.configuration.object_struct_responses ? to_object_struct(response) : response
       else
-        BeyondApi.logger.error "[Beyond API] #{response}"
-        BeyondApi.configuration.raise_error_requests ? raise(response.to_s) : BeyondApi::Error.new(response)
+        handle_error(response, status)
       end
     end
 
+    def handle_error(response, status)
+      BeyondApi.logger.error "[Beyond API] #{status}: #{response}"
+      error = BeyondApi::Error.new(response, status)
+      BeyondApi.configuration.raise_error_requests ? raise(error) : error
+    end
+
     def to_object_struct(data)
       if data.is_a? Hash
         return OpenStruct.new(data.map { |key, val| [key, to_object_struct(val)] }.to_h)
@@ -39,6 +44,22 @@ module BeyondApi
       key.chars.first == "_" ? key[1..-1] : key
     end
 
+    def handle_all_request(url, resource, params = {})
+      if params[:paginated] == false
+        result = all_paginated(url, { page: 0, size: 1000 })
+
+        (1..result[:page][:total_pages] - 1).each do |page|
+          result[:embedded][resource].concat(all_paginated(url, { page: page, size: 1000 })[:embedded][resource])
+        end
+
+        result.is_a?(Hash) ? result.delete(:page) : result.delete_field(:page)
+
+        result
+      else
+        all_paginated(url, params)
+      end
+    end
+
     private
 
       def transform(thing)
@@ -48,5 +69,11 @@ module BeyondApi
         else; thing
         end
       end
+
+      def all_paginated(url, params = {})
+        response, status = BeyondApi::Request.get(@session, url, params)
+
+        handle_response(response, status)
+      end
   end
 end

data/lib/beyond_api/version.rb

@@ -1,3 +1,3 @@
 module BeyondApi
-  VERSION = "0.8.1.pre".freeze
+  VERSION = "0.12.0.pre".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.8.1.pre
+  version: 0.12.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,6 +160,11 @@ files:
 - lib/beyond_api/resources/script_tags.rb
 - lib/beyond_api/resources/shipping_zones.rb
 - lib/beyond_api/resources/shop.rb
+- lib/beyond_api/resources/shops/address.rb
+- lib/beyond_api/resources/shops/attributes.rb
+- lib/beyond_api/resources/shops/images.rb
+- lib/beyond_api/resources/shops/legals.rb
+- lib/beyond_api/resources/shops/locations.rb
 - lib/beyond_api/resources/signers.rb
 - lib/beyond_api/resources/token.rb
 - lib/beyond_api/resources/users.rb
@@ -190,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby client to access the Beyond API