rms_api_ruby 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08380e4d50146bab769f56f4156751e4ce0b6788333f8c637198b7157994cb9b'
-  data.tar.gz: 9be7202be3b41ec3773ee918bc30c3190cb5b107b22a03f36564f8b655cc5009
+  metadata.gz: cd997f991888796c31485581f894b02fdb26e1cf0a355fd1c064d8bdb625e9a9
+  data.tar.gz: e9eb9d271154aba3e58c8009c22ed126a61fa53783cd7414afa7d5435395ee1e
 SHA512:
-  metadata.gz: 07e89f486b327e760986a491390a93784ea24c0c69f0a382dd5fcc28b529071347be4522101fb01eab727e7c09ca10c9b54a9049acfd290776d14609a2f4a510
-  data.tar.gz: f8edb76474508be2554e536770c2078741f2306d4133e9bb6458ac3f2d8b7da93924169c33c34f8618db597010589a21f34bf24fc49b15737d352b3ca13af1bb
+  metadata.gz: 54c1165fb6dd9c3c5c7dc2b3ccbafce5a17606168ab7652a5fb58081800356071573ea5eab6543ddd5860bbc24171c258ee6c4af57ccf71c43c8434ff531915a
+  data.tar.gz: 452c6a1eddd87373c2bebeb650db44e5832d24a6a6605b0a20a2d4802725ea3bb371ac4c334b112096b7d757bec83542500f66f5fbfd5002125831fb90bff9e9

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.4.0 (Jul 7, 2018)
+* Add Product API and Navigation API
+
 ## 0.3.0 (Jul 1, 2018)
 * Add Item API
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rms_api_ruby (0.3.0)
+    rms_api_ruby (0.4.0)
       activesupport
       hashie
       savon (~> 2.12.0)

data/README.md

@@ -4,17 +4,17 @@
 [![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 and ItemAPI.
+At this time this gem supports OrderAPI, InventoryAPI, ItemAPI, ProductAPI and NavigationAPI.
 
 Support
 - OrderAPI
 - InventoryAPI
 - ItemAPI
+- ProductAPI
+- NavigationAPI
 
 Not Support yet
-- ProductAPI
 - CabinetAPI
-- NavigationAPI
 - CategoryAPI
 - CouponAPI
 - ShopManagimentAPI
@@ -54,13 +54,15 @@ Or can set any of the options via this way
 
 ```ruby
 RmsApiRuby.configure do |config|
-  config.service_secret        = 'Your RMS service secret'
-  config.license_key           = 'Your RMS license key'
-  config.shop_url              = 'Your RMS shop url'
-  config.user_name             = 'user name'             # default 'rms_api_ruby'
-  config.order_api_version     = 'Order API version'     # default 1.0
-  config.inventory_api_version = 'Inventory API version' # default 1.0
-  config.item_api_version      = 'Item API version'      # default 1.0
+  config.service_secret         = 'Your RMS service secret'
+  config.license_key            = 'Your RMS license key'
+  config.shop_url               = 'Your RMS shop url'
+  config.user_name              = 'user name'              # default 'rms_api_ruby'
+  config.order_api_version      = 'Order API version'      # default 1.0
+  config.inventory_api_version  = 'Inventory API version'  # default 1.0
+  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
 end
 ```
 
@@ -68,12 +70,8 @@ end
 - [OrderAPI](docs/order_api.md)
 - [InventoryAPI](docs/inventory_api.md)
 - [ItemAPI](docs/item_api.md)
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- [ProductAPI](docs/product_api.md)
+- [NavigationAPI](docs/navigation_api.md)
 
 ## Contributing
 

data/docs/navigation_api.md

@@ -0,0 +1,44 @@
+## NavigationAPI
+
+### genre_get
+
+```ruby
+args = { genre_id: 202513 }
+
+response = RmsApiRuby::Navigation.genre_get(args)
+# => #<Hashie::Mash>
+
+response.keys
+# => ["status", "navigation_genre_get_result"]
+
+response.navigation_genre_get_result
+# => #<Hashie::Mash genre=#<Hashie::Mash ...>>
+```
+
+### genre_tag_get
+
+```ruby
+args = { genre_id: 202513 }
+
+response = RmsApiRuby::Navigation.genre_tag_get(args)
+# => #<Hashie::Mash>
+
+response.keys
+# => ["status", "navigation_genre_tag_get_result"]
+
+response.navigation_genre_tag_get_result
+# => #<Hashie::Mash genre=#<Hashie::Mash ...>>
+```
+
+### genre_header_get
+
+```ruby
+response = RmsApiRuby::Navigation.genre_header_get
+# => #<Hashie::Mash>
+
+response.keys
+# => ["status", "navigation_header_get_result"]
+
+response.navigation_header_get_result
+# => #<Hashie::Mash genre_last_update_date="2018-05-22T10:00:00+09:00" status="Success" tag_last_update_date="2018-05-22T10:00:00+09:00">
+```

data/docs/product_api.md

@@ -0,0 +1,19 @@
+## ProductAPI
+
+### search
+
+```ruby
+args = {
+  genre_id: 202513,
+  limit: 10,
+}
+
+response = RmsApiRuby::Product.search(args)
+# => #<Hashie::Mash>
+
+response.keys
+# => ["status", "product_search_result"]
+
+response.product_search_result
+# => #<Hashie::Mash pagination=#<Hashie::Mash ...>>
+```

data/lib/rms_api_ruby/config.rb

@@ -85,9 +85,11 @@ module RmsApiRuby
     option :logger,         default: ::Logger.new(STDOUT)
     option :log_level,      default: ::Logger::DEBUG
 
-    option :order_api_version,     default: '1.0'
-    option :inventory_api_version, default: '1.0'
-    option :item_api_version,      default: '1.0'
+    option :order_api_version,      default: '1.0'
+    option :inventory_api_version,  default: '1.0'
+    option :item_api_version,       default: '1.0'
+    option :product_api_version,    default: '2.0'
+    option :navigation_api_version, default: '1.0'
 
     def options
       self.class.options

data/lib/rms_api_ruby/item/base.rb

@@ -1,39 +1,10 @@
-require 'rms_api_ruby/chain'
-require 'rms_api_ruby/utility/hash_keys_camelizable'
+require 'rms_api_ruby/rest_api/base'
 
 module RmsApiRuby
   class Item
-    class Base
-      include Waterfall
-      include RmsApiRuby::HashKeysCamelizable
-
-      def initialize(args, client_class = RmsApiRuby::Chain::HttpClient)
-        @args   = args
-        @client = client_class.new(
-          method: http_method,
-          url: url,
-          params: form_params(args),
-          headers: http_headers,
-          return_method: :result
-        )
-      end
-
-      def call
-        chain { log :info, start_message }
-        chain(response: :response) { @client.call }
-        chain { log :info, complete_message }
-      end
-
+    class Base < RmsApiRuby::RestApi::Base
       private
 
-      def http_method
-        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-      end
-
-      def url
-        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
-      end
-
       def api_name
         raise NotImplementedError, "You must implement #{self.class}##{__method__}"
       end
@@ -46,14 +17,6 @@ module RmsApiRuby
         RmsApiRuby.configuration.item_api_version
       end
 
-      def http_headers
-        { Authorization: RmsApiRuby::Authentication.key }
-      end
-
-      def log(level, message)
-        RmsApiRuby::Chain::Logger.new(level, message)
-      end
-
       def start_message
         "RMS ItemAPI '#{api_name}' started. args: #{@args.inspect}"
       end
@@ -61,14 +24,6 @@ module RmsApiRuby
       def complete_message
         "RMS ItemAPI '#{api_name}' completed."
       end
-
-      def form_params(args)
-        if http_method == :get
-          camelize_keys(args, :lower)
-        else
-          camelize_keys(args, :lower).to_xml(root: :request, skip_types: true)
-        end
-      end
     end
   end
 end

data/lib/rms_api_ruby/navigation/base.rb

@@ -0,0 +1,29 @@
+require 'rms_api_ruby/rest_api/base'
+
+module RmsApiRuby
+  class Navigation
+    class Base < RmsApiRuby::RestApi::Base
+      private
+
+      def api_name
+        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+      end
+
+      def base_url
+        "https://api.rms.rakuten.co.jp/es/#{api_version}/navigation/"
+      end
+
+      def api_version
+        RmsApiRuby.configuration.navigation_api_version
+      end
+
+      def start_message
+        "RMS NavigationAPI '#{api_name}' started. args: #{@args.inspect}"
+      end
+
+      def complete_message
+        "RMS NavigationAPI '#{api_name}' completed."
+      end
+    end
+  end
+end

data/lib/rms_api_ruby/navigation/genre_get.rb

@@ -0,0 +1,21 @@
+require 'rms_api_ruby/navigation/base'
+
+module RmsApiRuby
+  class Navigation
+    class GenreGet < RmsApiRuby::Navigation::Base
+      private
+
+      def http_method
+        :get
+      end
+
+      def url
+        "#{base_url}genre/get"
+      end
+
+      def api_name
+        'genre get'
+      end
+    end
+  end
+end

data/lib/rms_api_ruby/navigation/genre_header_get.rb

@@ -0,0 +1,21 @@
+require 'rms_api_ruby/navigation/base'
+
+module RmsApiRuby
+  class Navigation
+    class GenreHeaderGet < RmsApiRuby::Navigation::Base
+      private
+
+      def http_method
+        :get
+      end
+
+      def url
+        "#{base_url}genre/header/get"
+      end
+
+      def api_name
+        'genre header get'
+      end
+    end
+  end
+end

data/lib/rms_api_ruby/navigation/genre_tag_get.rb

@@ -0,0 +1,21 @@
+require 'rms_api_ruby/navigation/base'
+
+module RmsApiRuby
+  class Navigation
+    class GenreTagGet < RmsApiRuby::Navigation::Base
+      private
+
+      def http_method
+        :get
+      end
+
+      def url
+        "#{base_url}genre/tag/get"
+      end
+
+      def api_name
+        'genre tag get'
+      end
+    end
+  end
+end

data/lib/rms_api_ruby/navigation.rb

@@ -0,0 +1,38 @@
+module RmsApiRuby
+  class Navigation
+    autoload :GenreGet,       'rms_api_ruby/navigation/genre_get'
+    autoload :GenreTagGet,    'rms_api_ruby/navigation/genre_tag_get'
+    autoload :GenreHeaderGet, 'rms_api_ruby/navigation/genre_header_get'
+
+    API_METHODS = %w[
+      genre_get
+      genre_tag_get
+      genre_header_get
+    ].freeze
+
+    class << self
+      API_METHODS.each do |api_method|
+        define_method api_method do |args = nil|
+          api_class = "RmsApiRuby::Navigation::#{api_method.camelize}"
+          call_api api_class.constantize.new(args)
+        end
+      end
+
+      private
+
+      def call_api(api)
+        Flow.new.
+          chain(response: :response) { api.call }.
+          on_dam { |error| handle_error(error) }.
+          outflow.
+          try(:response)
+      end
+
+      def handle_error(error)
+        raise error
+      rescue ServerError, AuthenticationError => e
+        RmsApiRuby.configuration.logger.error(e.message)
+      end
+    end
+  end
+end

data/lib/rms_api_ruby/product.rb

@@ -0,0 +1,47 @@
+require 'rms_api_ruby/rest_api/base'
+
+module RmsApiRuby
+  class Product
+    class << self
+      def search(args)
+        Flow.new.
+          chain(response: :response) { Client.new(args).call }.
+          on_dam { |error| handle_error(error) }.
+          outflow.
+          try(:response)
+      end
+
+      private
+
+      def handle_error(error)
+        raise error
+      rescue ServerError, AuthenticationError => e
+        RmsApiRuby.configuration.logger.error(e.message)
+      end
+    end
+
+    class Client < RmsApiRuby::RestApi::Base
+      private
+
+      def http_method
+        :get
+      end
+
+      def url
+        "https://api.rms.rakuten.co.jp/es/#{api_version}/product/search"
+      end
+
+      def start_message
+        "RMS ProductAPI 'SEARCH' started. args: #{@args.inspect}"
+      end
+
+      def complete_message
+        "RMS ProductAPI 'SEARCH' completed."
+      end
+
+      def api_version
+        RmsApiRuby.configuration.product_api_version
+      end
+    end
+  end
+end

data/lib/rms_api_ruby/rest_api/base.rb

@@ -0,0 +1,65 @@
+require 'rms_api_ruby/chain'
+require 'rms_api_ruby/utility/hash_keys_camelizable'
+
+module RmsApiRuby
+  class RestApi
+    class Base
+      include Waterfall
+      include RmsApiRuby::HashKeysCamelizable
+
+      def initialize(args, client_class = RmsApiRuby::Chain::HttpClient)
+        @args   = args
+        @client = client_class.new(
+          method: http_method,
+          url: url,
+          params: form_params(args),
+          headers: http_headers,
+          return_method: :result
+        )
+      end
+
+      def call
+        chain { log :info, start_message }
+        chain(response: :response) { @client.call }
+        chain { log :info, complete_message }
+      end
+
+      private
+
+      def http_method
+        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+      end
+
+      def url
+        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+      end
+
+      def start_message
+        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+      end
+
+      def complete_message
+        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+      end
+
+      def http_headers
+        { Authorization: RmsApiRuby::Authentication.key }
+      end
+
+      def log(level, message)
+        RmsApiRuby::Chain::Logger.new(level, message)
+      end
+
+      def form_params(args)
+        camelized_params = camelize_keys(args, :lower)
+        if http_method == :get
+          camelized_params
+        elsif camelized_params.nil?
+          nil
+        else
+          camelized_params.to_xml(root: :request, skip_types: true)
+        end
+      end
+    end
+  end
+end

data/lib/rms_api_ruby/utility/hash_keys_camelizable.rb

@@ -3,6 +3,7 @@ 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) }

data/lib/rms_api_ruby/utility/hash_keys_underscorable.rb

@@ -3,6 +3,7 @@ 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) }

data/lib/rms_api_ruby/version.rb

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

data/lib/rms_api_ruby.rb

@@ -17,6 +17,8 @@ module RmsApiRuby
   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'
 
   def self.root
     File.dirname __dir__

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rms_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kaicoh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-30 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -187,7 +187,9 @@ files:
 - config/wsdl/inventory_v_1.0.wsdl
 - docs/inventory_api.md
 - docs/item_api.md
+- docs/navigation_api.md
 - docs/order_api.md
+- docs/product_api.md
 - lib/rms_api_ruby.rb
 - lib/rms_api_ruby/authentication.rb
 - lib/rms_api_ruby/chain.rb
@@ -204,8 +206,15 @@ 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/navigation.rb
+- lib/rms_api_ruby/navigation/base.rb
+- lib/rms_api_ruby/navigation/genre_get.rb
+- lib/rms_api_ruby/navigation/genre_header_get.rb
+- lib/rms_api_ruby/navigation/genre_tag_get.rb
 - lib/rms_api_ruby/order.rb
 - lib/rms_api_ruby/orders.rb
+- lib/rms_api_ruby/product.rb
+- lib/rms_api_ruby/rest_api/base.rb
 - lib/rms_api_ruby/soap_api.rb
 - lib/rms_api_ruby/soap_api/client.rb
 - lib/rms_api_ruby/utility/hash_keys_camelizable.rb