rms_api_ruby 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd997f991888796c31485581f894b02fdb26e1cf0a355fd1c064d8bdb625e9a9
-  data.tar.gz: e9eb9d271154aba3e58c8009c22ed126a61fa53783cd7414afa7d5435395ee1e
+  metadata.gz: 7762bfa27a1e1e29ac1b420e384cfc22e67fb439fad89d23354f87bc143918a9
+  data.tar.gz: 3ee5168db64bac9a2150d1bff742e4c7ab1a907f24e18392ba07b1a96a43b663
 SHA512:
-  metadata.gz: 54c1165fb6dd9c3c5c7dc2b3ccbafce5a17606168ab7652a5fb58081800356071573ea5eab6543ddd5860bbc24171c258ee6c4af57ccf71c43c8434ff531915a
-  data.tar.gz: 452c6a1eddd87373c2bebeb650db44e5832d24a6a6605b0a20a2d4802725ea3bb371ac4c334b112096b7d757bec83542500f66f5fbfd5002125831fb90bff9e9
+  metadata.gz: 378ce3feab6d4eb6b0d6873feb26112a34f42eb77f87a440e1d089c862ba45d0b8a9b8aae0480e1aa3284dc4e273a1b7cf450e7e84d16efd50e6909e3c9b96b9
+  data.tar.gz: 2be436d5e6b29396e60987ddbe2dff210f644131613be07f540a1eb33e18bab16db1b0369a9ba2303a2c86ed4e67eaa297e72bf1b1eb5b0287dcb8b2b679cc44

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.5.0 (Aug 5, 2018)
+* Add RakutenPayOrder API
+
 ## 0.4.0 (Jul 7, 2018)
 * Add Product API and Navigation API
 

data/Gemfile.lock

@@ -1,9 +1,12 @@
 PATH
   remote: .
   specs:
-    rms_api_ruby (0.4.0)
+    rms_api_ruby (0.5.0)
       activesupport
+      faraday
+      faraday_middleware
       hashie
+      multi_xml
       savon (~> 2.12.0)
       waterfall (~> 1.2.0)
 
@@ -28,6 +31,10 @@ GEM
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
     gyoku (1.3.1)
       builder (>= 2.1.2)
     hashdiff (0.3.7)
@@ -41,7 +48,9 @@ GEM
     method_source (0.9.0)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
-    nokogiri (1.8.3)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nokogiri (1.8.4)
       mini_portile2 (~> 2.3.0)
     nori (2.6.0)
     parallel (1.12.1)

data/README.md

@@ -4,7 +4,7 @@
 [![CircleCI](https://circleci.com/gh/Kaicoh/rms_api_ruby/tree/master.svg?style=svg)](https://circleci.com/gh/Kaicoh/rms_api_ruby/tree/master)
 
 RmsApiRuby is a ruby gem for the RMS(Rakuten Marchant Service) Web API. By default all API calls will return [Hashie::Mash](https://github.com/intridea/hashie/tree/v1.2.0) objects.  
-At this time this gem supports OrderAPI, InventoryAPI, ItemAPI, ProductAPI and NavigationAPI.
+At this time the APIs this gem supports are as follows.
 
 Support
 - OrderAPI
@@ -12,6 +12,7 @@ Support
 - ItemAPI
 - ProductAPI
 - NavigationAPI
+- RakutenPayOrderAPI
 
 Not Support yet
 - CabinetAPI
@@ -19,7 +20,6 @@ Not Support yet
 - CouponAPI
 - ShopManagimentAPI
 - System Event Notification Service
-- RakutenPayOrderAPI
 - PaymentAPI
 
 ## Installation
@@ -63,6 +63,7 @@ RmsApiRuby.configure do |config|
   config.item_api_version       = 'Item API version'       # default 1.0
   config.product_api_version    = 'Product API version'    # default 2.0
   config.navigation_api_version = 'Navigation API version' # default 1.0
+  config.rakuten_pay_order_api_version = 'RakutenPayOrder API version' # default 2.0
 end
 ```
 
@@ -72,6 +73,7 @@ end
 - [ItemAPI](docs/item_api.md)
 - [ProductAPI](docs/product_api.md)
 - [NavigationAPI](docs/navigation_api.md)
+- [RakutenPayOrderAPI](docs/rakuten_pay_order_api.md)
 
 ## Contributing
 

data/docs/rakuten_pay_order_api.md

@@ -0,0 +1,17 @@
+## RakutenPayOrderAPI
+
+### GetOrder
+
+```ruby
+args = {
+  order_number_list: ['Rakuten order number you want'],
+}
+response = RmsApiRuby::RakutenPayOrder.get_order(args)
+# => #<Hashie::Mash>
+
+response.keys
+# => ["message_model_list", "order_model_list"]
+
+rakuten_order = response.order_model
+# => #<Hashie::Array>
+```

data/lib/rms_api_ruby.rb

@@ -1,7 +1,9 @@
 require 'active_support'
 require 'active_support/core_ext'
 require 'waterfall'
-require 'pry'
+require 'hashie'
+require 'faraday'
+require 'faraday_middleware'
 require "rms_api_ruby/version"
 require 'rms_api_ruby/config'
 
@@ -10,15 +12,17 @@ module RmsApiRuby
   ServerError         = Class.new(Error)
   AuthenticationError = Class.new(Error)
 
-  autoload :Authentication, 'rms_api_ruby/authentication'
-  autoload :Chain,          'rms_api_ruby/chain'
-  autoload :Order,          'rms_api_ruby/order'
-  autoload :Orders,         'rms_api_ruby/orders'
-  autoload :Inventory,      'rms_api_ruby/inventory'
-  autoload :Item,           'rms_api_ruby/item'
-  autoload :Items,          'rms_api_ruby/items'
-  autoload :Product,        'rms_api_ruby/product'
-  autoload :Navigation,     'rms_api_ruby/navigation'
+  autoload :Authentication,  'rms_api_ruby/authentication'
+  autoload :Middleware,      'rms_api_ruby/middleware'
+  autoload :Chain,           'rms_api_ruby/chain'
+  autoload :Order,           'rms_api_ruby/order'
+  autoload :Orders,          'rms_api_ruby/orders'
+  autoload :Inventory,       'rms_api_ruby/inventory'
+  autoload :Item,            'rms_api_ruby/item'
+  autoload :Items,           'rms_api_ruby/items'
+  autoload :Product,         'rms_api_ruby/product'
+  autoload :Navigation,      'rms_api_ruby/navigation'
+  autoload :RakutenPayOrder, 'rms_api_ruby/rakuten_pay_order'
 
   def self.root
     File.dirname __dir__

data/lib/rms_api_ruby/config.rb

@@ -90,6 +90,7 @@ module RmsApiRuby
     option :item_api_version,       default: '1.0'
     option :product_api_version,    default: '2.0'
     option :navigation_api_version, default: '1.0'
+    option :rakuten_pay_order_api_version, default: '2.0'
 
     def options
       self.class.options

data/lib/rms_api_ruby/middleware.rb

@@ -0,0 +1,16 @@
+module RmsApiRuby
+  class Middleware
+    autoload :Camelcase, 'rms_api_ruby/middleware/camelcase'
+    autoload :Snakecase, 'rms_api_ruby/middleware/snakecase'
+    autoload :ParseMash, 'rms_api_ruby/middleware/parse_mash'
+
+    if Faraday::Middleware.respond_to? :register_middleware
+      Faraday::Request.register_middleware \
+        camelcase: -> { Camelcase }
+
+      Faraday::Response.register_middleware \
+        snakecase: -> { Snakecase },
+        parse_mash: -> { ParseMash }
+    end
+  end
+end

data/lib/rms_api_ruby/middleware/camelcase.rb

@@ -0,0 +1,14 @@
+require 'rms_api_ruby/utility/hash_keys_camelizable'
+
+module RmsApiRuby
+  class Middleware
+    class Camelcase < Faraday::Middleware
+      include RmsApiRuby::HashKeysCamelizable
+
+      def call(env)
+        env[:body] = camelize_keys(env[:body], :lower)
+        @app.call env
+      end
+    end
+  end
+end

data/lib/rms_api_ruby/middleware/parse_mash.rb

@@ -0,0 +1,11 @@
+require 'hashie/mash'
+
+module RmsApiRuby
+  class Middleware
+    class ParseMash < Faraday::Response::Middleware
+      def on_complete(env)
+        env[:body] = Hashie::Mash.new(env[:body])
+      end
+    end
+  end
+end

data/lib/rms_api_ruby/middleware/snakecase.rb

@@ -0,0 +1,13 @@
+require 'rms_api_ruby/utility/hash_keys_underscorable'
+
+module RmsApiRuby
+  class Middleware
+    class Snakecase < Faraday::Response::Middleware
+      include RmsApiRuby::HashKeysUnderscorable
+
+      def on_complete(env)
+        env[:body] = snake_keys env[:body]
+      end
+    end
+  end
+end

data/lib/rms_api_ruby/rakuten_pay_order.rb

@@ -0,0 +1,59 @@
+require 'rms_api_ruby/middleware'
+
+module RmsApiRuby
+  class RakutenPayOrder
+    BASE_URL = 'https://api.rms.rakuten.co.jp'.freeze
+    API_METHODS = %w[
+      get_order
+      search_order
+      confirm_order
+      update_order_shipping
+      update_order_delivery
+      update_order_orderer
+      update_order_remarks
+      update_order_sender
+      update_order_memo
+      get_payment
+      cancel_order
+      get_sub_status_list
+      update_order_sub_status
+    ].freeze
+
+    class << self
+      API_METHODS.each do |api_method|
+        define_method api_method do |args = nil|
+          connection.post do |req|
+            req.url endpoint(api_method)
+            req.headers['Content-Type'] = 'application/json; charset=utf-8'
+            req.headers['Authorization'] = RmsApiRuby::Authentication.key
+            req.body = args
+          end.try(:body)
+        end
+      end
+
+      private
+
+      def connection
+        Faraday.new(url: BASE_URL) do |faraday|
+          faraday.request  :camelcase
+          faraday.request  :url_encoded
+          faraday.request  :json
+
+          faraday.response :logger
+          faraday.response :parse_mash
+          faraday.response :snakecase
+          faraday.response :xml,  content_type: /\bxml$/
+          faraday.response :json, content_type: /\bjson$/
+
+          faraday.use :instrumentation
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+
+      def endpoint(api_method)
+        "/es/#{RmsApiRuby.configuration.rakuten_pay_order_api_version}" \
+        "/order/#{api_method.to_s.camelize(:lower)}/"
+      end
+    end
+  end
+end

data/lib/rms_api_ruby/utility/hash_keys_camelizable.rb

@@ -3,14 +3,17 @@ require 'active_support/core_ext'
 module RmsApiRuby
   module HashKeysCamelizable
     def camelize_keys(hash, first_letter = :upper)
-      return nil if hash.nil?
-      hash.each_with_object({}) do |(key, val), acc|
-        if val.is_a?(Array)
-          val = val.map { |v| to_camel_keys(v, first_letter) }
-        elsif val.is_a?(Hash)
-          val = camelize_keys(val, first_letter)
+      if hash.respond_to? :each_with_object
+        hash.each_with_object({}) do |(key, val), acc|
+          if val.is_a?(Array)
+            val = val.map { |v| to_camel_keys(v, first_letter) }
+          elsif val.is_a?(Hash)
+            val = camelize_keys(val, first_letter)
+          end
+          acc[camel_key(key, first_letter)] = val
         end
-        acc[camel_key(key, first_letter)] = val
+      else
+        hash
       end
     end
 

data/lib/rms_api_ruby/utility/hash_keys_underscorable.rb

@@ -3,14 +3,17 @@ require 'active_support/core_ext'
 module RmsApiRuby
   module HashKeysUnderscorable
     def snake_keys(hash)
-      return nil if hash.nil?
-      hash.each_with_object({}) do |(key, val), acc|
-        if val.is_a?(Array)
-          val = val.map { |v| to_snake_keys(v) }
-        elsif val.is_a?(Hash)
-          val = snake_keys(val)
+      if hash.respond_to? :each_with_object
+        hash.each_with_object({}) do |(key, val), acc|
+          if val.is_a?(Array)
+            val = val.map { |v| to_snake_keys(v) }
+          elsif val.is_a?(Hash)
+            val = snake_keys(val)
+          end
+          acc[snake_key(key)] = val
         end
-        acc[snake_key(key)] = val
+      else
+        hash
       end
     end
 

data/lib/rms_api_ruby/version.rb

@@ -1,3 +1,3 @@
 module RmsApiRuby
-  VERSION = "0.4.0".freeze
+  VERSION = "0.5.0".freeze
 end

data/rms_api_ruby.gemspec

@@ -35,7 +35,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'activesupport'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
   spec.add_dependency 'hashie'
+  spec.add_dependency 'multi_xml'
   spec.add_dependency 'savon', '~> 2.12.0'
   spec.add_dependency 'waterfall', '~> 1.2.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rms_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kaicoh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-06 00:00:00.000000000 Z
+date: 2018-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +232,7 @@ files:
 - docs/navigation_api.md
 - docs/order_api.md
 - docs/product_api.md
+- docs/rakuten_pay_order_api.md
 - lib/rms_api_ruby.rb
 - lib/rms_api_ruby/authentication.rb
 - lib/rms_api_ruby/chain.rb
@@ -206,6 +249,10 @@ files:
 - lib/rms_api_ruby/item/search.rb
 - lib/rms_api_ruby/item/update.rb
 - lib/rms_api_ruby/items.rb
+- lib/rms_api_ruby/middleware.rb
+- lib/rms_api_ruby/middleware/camelcase.rb
+- lib/rms_api_ruby/middleware/parse_mash.rb
+- lib/rms_api_ruby/middleware/snakecase.rb
 - lib/rms_api_ruby/navigation.rb
 - lib/rms_api_ruby/navigation/base.rb
 - lib/rms_api_ruby/navigation/genre_get.rb
@@ -214,6 +261,7 @@ files:
 - lib/rms_api_ruby/order.rb
 - lib/rms_api_ruby/orders.rb
 - lib/rms_api_ruby/product.rb
+- lib/rms_api_ruby/rakuten_pay_order.rb
 - lib/rms_api_ruby/rest_api/base.rb
 - lib/rms_api_ruby/soap_api.rb
 - lib/rms_api_ruby/soap_api/client.rb