beyond_api 0.1.0.pre

data/lib/beyond_api/utils.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+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
+      else
+        BeyondApi::Error.new(response)
+      end
+    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)
+      elsif data.is_a? Array
+        return data.map { |o| to_object_struct(o) }
+      else
+        return data
+      end
+    end
+
+    def sanitize_response(hash)
+      {}.tap do |h|
+        hash.each do |key, value|
+          next if key == "_links" && BeyondApi.configuration.remove_response_links
+          key = sanitize_key(key) if BeyondApi.configuration.remove_response_key_underscores
+          h[key.underscore.to_sym] = transform(value)
+        end
+      end
+    end
+
+    def sanitize_key(key)
+      key.chars.first == "_" ? key[1..-1] : key
+    end
+
+    private
+
+      def transform(thing)
+        case thing
+        when Hash; sanitize_response(thing)
+        when Array; thing.map { |v| transform(v) }
+        else; thing
+        end
+      end
+  end
+end

data/lib/beyond_api/version.rb

@@ -0,0 +1,3 @@
+module BeyondApi
+  VERSION = "0.1.0.pre".freeze
+end

data/lib/generators/beyond_api/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BeyondApi
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def copy_initializer
+        template "beyond_api_initializer.rb", "config/initializers/beyond_api.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/beyond_api_initializer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+BeyondApi.setup do |config|
+  # ==> Client configuration
+  config.client_id = nil
+  config.client_secret = nil
+
+  # ==> Api configuration
+  # Configure the open connection timeout in seconds. Default is 2 seconds.
+  # config.open_timeout = 2.seconds
+
+  # Configure the request timeout in seconds. Default is 5 seconds.
+  # config.timeout = 5.seconds
+
+  # ==> Response configuration
+  # Configure if :_links should be removed from response. Default is false and
+  # :_links are gonna be part of the response.
+  # config.remove_response_links = false
+
+  # Configure if first character underescores should be removed on response hash
+  # keys. For example, if set to true, :_id will become :id. Default is false.
+  # config.remove_response_key_underscores = false
+
+  # Configure if responses should be transformed to ObjectStructs. If set to
+  # true, it gives you the posibility to access response data on a doted way.
+  # With OpenStructs => response.embeded.products.first.id
+  # Without OpenStructs => response["embeded"]["products"].first["id"]
+  # config.object_struct_responses = false
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: beyond_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Unai Abrisketa
+- Kathia Salazar
+- German San Emeterio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- GETTING_STARTED.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- beyond_api.gemspec
+- bin/console
+- bin/setup
+- lib/beyond_api.rb
+- lib/beyond_api/connection.rb
+- lib/beyond_api/ext.rb
+- lib/beyond_api/request.rb
+- lib/beyond_api/resources/base.rb
+- lib/beyond_api/resources/carts.rb
+- lib/beyond_api/resources/categories.rb
+- lib/beyond_api/resources/categories_view.rb
+- lib/beyond_api/resources/checkout_settings.rb
+- lib/beyond_api/resources/newsletter_target.rb
+- lib/beyond_api/resources/order_settings.rb
+- lib/beyond_api/resources/orders.rb
+- lib/beyond_api/resources/payment_methods.rb
+- lib/beyond_api/resources/product_attribute_definitions.rb
+- lib/beyond_api/resources/product_settings.rb
+- lib/beyond_api/resources/products.rb
+- lib/beyond_api/resources/products/attachments.rb
+- lib/beyond_api/resources/products/availability.rb
+- lib/beyond_api/resources/products/custom_attributes.rb
+- lib/beyond_api/resources/products/images.rb
+- lib/beyond_api/resources/products/searches.rb
+- lib/beyond_api/resources/products/variation_properties.rb
+- lib/beyond_api/resources/products_view.rb
+- lib/beyond_api/resources/scopes.rb
+- lib/beyond_api/resources/script_tags.rb
+- lib/beyond_api/resources/shipping_zones.rb
+- lib/beyond_api/resources/shop.rb
+- lib/beyond_api/resources/signers.rb
+- lib/beyond_api/resources/token.rb
+- lib/beyond_api/resources/users.rb
+- lib/beyond_api/resources/variations.rb
+- lib/beyond_api/resources/variations/availability.rb
+- lib/beyond_api/resources/webhook_subscriptions.rb
+- lib/beyond_api/session.rb
+- lib/beyond_api/utils.rb
+- lib/beyond_api/version.rb
+- lib/generators/beyond_api/install_generator.rb
+- lib/generators/templates/beyond_api_initializer.rb
+homepage: https://github.com/ePages-de/beyond_api-ruby_client
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client to access the Beyond API
+test_files: []