flex_commerce_api 0.7 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30004ed9299f30f35981aab7dfebe49fb3665449c02f827c86d1e678e66d8776
-  data.tar.gz: ea5dcde40fca7ded2737675da0f0208ab2846b7fe4266769cf56b49275104a3a
+  metadata.gz: 3ca38dba4a1fd2e2fc35b89ae3f66a7c22ba83ce2300bfcc5ccca0eb56febdcd
+  data.tar.gz: 551f7ba8158e64c66d2c076fabbdb99279a3441fdc27ff5ac6799c041808b378
 SHA512:
-  metadata.gz: 5fb1d9ddc76030328010fa15f3985d9594650e603b399ecde71832d25fc2dcf7365305f30e09a38ee68baca6a4986ee779bd9d3965e40ae1316af9a150cc169f
-  data.tar.gz: ffcd68fc795a6221fd17b391f1859ebf4a142d0842c71f134d40077ac6c77154a2ad1be8e771e1336310298f6008bfb7952830fd34b911c773d11258dd543a51
+  metadata.gz: e148bcc1259523c421add780130a28a3d445696c086e4b894f56a4432d480c512b08da6aa4e575d06f040f05000db776301759a993dc8920aff2be069cf83922
+  data.tar.gz: be0b5a2e09f14d3638ab5d7ff75da1953f5c5fdf19c57c44ef5af67aaaffb1be0f81ecfe98225df8b81a1fba6185d71aee7b16d62e7d0e6c86f796ce8a122de3

data/.circleci/config.yml

@@ -0,0 +1,45 @@
+version: '2.1'
+
+jobs:
+  build-ruby-27:
+    docker: 
+      - image: circleci/ruby:2.7.0
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - rubygems-27-cache-{{ .Branch }}-{{ checksum "Gemfile" }}-{{ checksum "flex-commerce-api.gemspec" }}
+            - rubygems-27-cache-{{ .Branch }}
+            - rubygems-27-cache
+      - run: bundle install --path vendor/bundle
+      - save_cache:
+          key: rubygems-27-cache-{{ .Branch }}-{{ checksum "Gemfile" }}-{{ checksum "flex-commerce-api.gemspec" }}
+          paths:
+            - vendor/bundle
+      - run: bundle exec rspec
+      
+  build-ruby-25:
+    docker: 
+      - image: circleci/ruby:2.5.3
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - rubygems-25-cache-{{ .Branch }}-{{ checksum "Gemfile" }}-{{ checksum "flex-commerce-api.gemspec" }}
+            - rubygems-25-cache-{{ .Branch }}
+            - rubygems-25-cache
+      - run: gem install bundler -v "~> 1.17"
+      - run: bundle install --path vendor/bundle
+      - save_cache:
+          key: rubygems-25-cache-{{ .Branch }}-{{ checksum "Gemfile" }}-{{ checksum "flex-commerce-api.gemspec" }}
+          paths:
+            - vendor/bundle
+      - run: bundle exec rspec
+
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - build-ruby-27
+      - build-ruby-25

data/.github/workflows/gempush.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "lib/flex_commerce_api/version.rb"
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.7.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.7.0

data/README.md

@@ -12,15 +12,19 @@ gem 'flex-commerce-api'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install flex-commerce-api
+```
+$ gem install flex-commerce-api
+```
 
 ## Usage
 
-The gem provides many models in the FlexCommerce namespace.  The example below is a rails controller
+The gem provides many models in the FlexCommerce namespace. The example below is a rails controller
 accessing a list of products.
 
 ```ruby
@@ -31,15 +35,46 @@ class ProductsController < ApplicationController
     @products = FlexCommerce::Product.paginate(params[:page])
   end
 end
-
 ```
 
 To any rails developer this will look familiar.
 
 However, we do not force you to use rails.  We appreciate that there are many frameworks out there
 and whilst rails is an excellent tool, for smaller projects you may want to look at others such
-as sinatra etc...
+as Sinatra etc...
+
+### Client IP address tracing in Rails apps
+
+Add the request store gem to your Gemfile and install
+
+```ruby
+gem "request-store"
+```
+
+```sh
+bundle install
+```
 
+```ruby
+# application_controller.rb
+class ApplicationController
+  before_action :set_request_ip
+
+  private
+
+  def set_request_ip
+    RequestStore[:request_ip] = request.remote_ip
+  end
+end
+```
+
+Configure the API client to pick up set value
+
+```ruby
+FlexCommerceApi.config do |config|
+  config.forwarded_for = ->{ RequestStore[:request_ip] }
+end
+```
 
 ## Development
 

data/flex-commerce-api.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "flex_commerce_api/version"
@@ -19,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "bundler", ">= 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "webmock", "~> 1.21"

data/lib/flex_commerce_api/base_resource.rb

@@ -10,6 +10,7 @@ require "flex_commerce_api/json_api_client_extension/status_middleware"
 require "flex_commerce_api/json_api_client_extension/json_format_middleware"
 require "flex_commerce_api/json_api_client_extension/previewed_request_middleware"
 require "flex_commerce_api/json_api_client_extension/capture_surrogate_keys_middleware"
+require "flex_commerce_api/json_api_client_extension/forwarded_for_middleware"
 require "flex_commerce_api/json_api_client_extension/has_many_association_proxy"
 require "flex_commerce_api/json_api_client_extension/builder"
 require "flex_commerce_api/json_api_client_extension/flexible_connection"

data/lib/flex_commerce_api/config.rb

@@ -27,14 +27,31 @@ module FlexCommerceApi
     #  section of the admin panel
     # @!attribute order_test_mode
     #  The order test mode.This config determines if orders are processed as test or real orders
-    attr_accessor :flex_root_url, :flex_api_key, :flex_account, :logger, :adapter, :order_test_mode, :http_cache, :open_timeout, :timeout, :paypal_login, :paypal_password, :paypal_signature, :order_test_mode, :paypal_connection_errors_no_of_retries
+
+    attr_accessor(
+      :flex_root_url,
+      :flex_api_key,
+      :flex_account,
+      :logger,
+      :adapter,
+      :http_cache,
+      :open_timeout,
+      :timeout,
+      :paypal_login,
+      :paypal_password,
+      :paypal_signature,
+      :order_test_mode,
+      :paypal_connection_errors_no_of_retries,
+      :forwarded_for
+    )
+
     attr_reader :api_version
 
     def initialize
       self.order_test_mode = false
       self.http_cache = {}
-      self.open_timeout = ENV.fetch('SHIFT_OPEN_TIMEOUT', 2).to_i
-      self.timeout = ENV.fetch('SHIFT_TIMEOUT', 15).to_i
+      self.open_timeout = ENV.fetch("SHIFT_OPEN_TIMEOUT", 2).to_i
+      self.timeout = ENV.fetch("SHIFT_TIMEOUT", 15).to_i
     end
 
     # The api base URL
@@ -50,6 +67,5 @@ module FlexCommerceApi
     def reconfigure_all!
       FlexCommerceApi::BaseResource.reconfigure_all if FlexCommerceApi.const_defined? "ApiBase"
     end
-
   end
 end

data/lib/flex_commerce_api/json_api_client_extension/forwarded_for_middleware.rb

@@ -0,0 +1,17 @@
+module FlexCommerceApi
+  module JsonApiClientExtension
+    # Looks for a lambda defined on the config, calls and assigns it to the
+    # outgoing request headers
+    class ForwardedForMiddleware < Faraday::Middleware
+      def call(env)
+        forwarded_for = FlexCommerceApi.config.forwarded_for
+
+        if forwarded_for.respond_to?(:call)
+          env[:request_headers]["X-Forwarded-For"] = forwarded_for.call
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/flex_commerce_api/version.rb

@@ -1,3 +1,3 @@
 module FlexCommerceApi
-  VERSION = '0.7'
+  VERSION = "0.8.1"
 end

data/lib/json_struct.rb

@@ -1,14 +1,13 @@
-require 'ostruct'
+require "ostruct"
 require "json"
 
 class JsonStruct < OpenStruct
-  def initialize(hash=nil)
-
+  def initialize(hash = nil)
     @table = {}
     @hash_table = {}
 
     if hash
-      recurse = Proc.new do |item|
+      recurse = proc { |item|
         values = []
 
         item.each do |val|
@@ -25,18 +24,16 @@ class JsonStruct < OpenStruct
         item.push(*values)
 
         item
-      end
-
-      hash.each do |k,v|
+      }
 
+      hash.each do |k, v|
         if v.is_a?(Array)
           recurse.call(v)
         end
 
         @table[k.to_sym] = (v.is_a?(Hash) ? self.class.new(v) : v)
         @hash_table[k.to_sym] = v
-        new_ostruct_member(k)
-
+        new_ostruct_member!(k)
       end
     end
   end
@@ -45,8 +42,8 @@ class JsonStruct < OpenStruct
     op = {}
 
     @table.each_pair do |key, value|
-      if value.is_a?(Array)
-        op[key] = value.map do |item|
+      op[key] = if value.is_a?(Array)
+        value.map do |item|
           if item.is_a?(self.class)
             item.to_h
           else
@@ -54,20 +51,19 @@ class JsonStruct < OpenStruct
           end
         end
       elsif value.is_a?(self.class)
-        op[key] = value.to_h
+        value.to_h
       else
-        op[key] = value
+        value
       end
     end
     op
   end
 
   def as_json(*args)
-   to_h
+    to_h
   end
 
   def to_json
     JSON.dump(to_h)
   end
-
-end
+end

data/lib/paypal_express/cart_shipping_method.rb

@@ -1,14 +1,13 @@
-require 'bigdecimal'
+require "bigdecimal"
 
 # @module FlexCommerce::PaypalExpress
 module FlexCommerce
   module PaypalExpress
     # @class CartShippingMethod
-    # 
+    #
     # Used to decorate shipping methods based on Promotions
     class CartShippingMethod < SimpleDelegator
-
-      ZERO = BigDecimal.new(0)
+      ZERO = BigDecimal(0)
 
       def initialize(shipping_method, free)
         super(shipping_method)
@@ -32,7 +31,6 @@ module FlexCommerce
       private
 
       attr_accessor :free
-
     end
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: flex_commerce_api
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: 0.8.1
 platform: ruby
 authors:
 - Gary Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-06 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -275,7 +275,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".env.example"
+- ".github/workflows/gempush.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -386,6 +388,7 @@ files:
 - lib/flex_commerce_api/json_api_client_extension/builder.rb
 - lib/flex_commerce_api/json_api_client_extension/capture_surrogate_keys_middleware.rb
 - lib/flex_commerce_api/json_api_client_extension/flexible_connection.rb
+- lib/flex_commerce_api/json_api_client_extension/forwarded_for_middleware.rb
 - lib/flex_commerce_api/json_api_client_extension/has_many_association_proxy.rb
 - lib/flex_commerce_api/json_api_client_extension/included_data.rb
 - lib/flex_commerce_api/json_api_client_extension/json_format_middleware.rb
@@ -462,8 +465,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Access the flex-commerce API