futureshop 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f2fd23ed1fbea603b0fb85215daf907df8452b0e33af3224ff368101f3a69dd
-  data.tar.gz: 3552f0d56f12cbfc5338b62f673e6c99b4ddda9d81216a9a1afcf9523b8a266e
+  metadata.gz: 9c7319b9455fdd1e3d74f600e88bb4412ae18cb9bc44dd21ae9f0b3cf973abf2
+  data.tar.gz: 442ee86969ef328888583a4161342d872a17414581a0e7ce2e160c7aa8437f6e
 SHA512:
-  metadata.gz: 88c85c2e8a2be55b4f937a4b6052241b740c0c16b3e57b1597cc42afa63e503013aff67111527297c3cb22fe5760cc399d06e6bf2a9b620dccd8e016ec789b2d
-  data.tar.gz: f0b1c12f981157dafb3ee4fd5e086675ae9de82dc0083cced20742aa881fe67285071e8248fa68fb69067b7f1cdb401d8dabf72dfc2233d973e83f253d73b046
+  metadata.gz: 4255adf63d28af1d55988b826d8be1c0f791ef805163fa193a869a3e41d902c4534a94fbcb73f4572e92d2d897f211208c32973ccae2ab4ef159c19850d8e70b
+  data.tar.gz: fac3eaece886d91a44021dc688c3e6cd196334fba574f4956dc6403bf53c04677041f96cd71f27abe2de7d39a1f79f31f361422bf59e841562168dd868ad039b

data/.gitlab-ci.yml

@@ -4,6 +4,6 @@ before_script:
   - gem install bundler -v 2.2.21
   - bundle install
 
-example_job:
+test:
   script:
     - bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 ## [Unreleased]
 
+## [0.1.6] - 2021-11-04
+
+- Change required Ruby version from 3.0.0 to 2.7.0
+- Complete command options
+
+## [0.1.5] - 2021-10-21
+
+- Add `Futureshop::Inventory` class
+- Add `inventories` subcommand
+
+## [0.1.4] - 2021-10-11
+
+- Handle order's couponList field, which was introduced on 2021-09-29
+
+## [0.1.3] - 2021-08-25
+
+- Fix option passing
+- Fix handling of nextUrl
+
 ## [0.1.2] - 2021-08-06
 
 - Fix command-line option name

data/README.md

@@ -21,6 +21,7 @@ Or install it yourself as:
 ## Usage
 
     futureshop orders -fcsv --order-date-start=2016-07-05 --order-date-end=2021-07-20 > orders.2021-07-20.csv
+    futureshop inventories --type=regular,preorder
 
 ## Development
 
@@ -30,4 +31,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and merge requests are welcome on GitHub at https://gitlab.com/KitaitiMakoto/futuresohp
+Bug reports and merge requests are welcome on GitHub at https://gitlab.com/KitaitiMakoto/futureshop

data/exe/futureshop

@@ -4,7 +4,7 @@ require "optparse"
 require "optparse/time"
 require "futureshop"
 
-SUPPORTED_COMMANDS = %w[orders]
+SUPPORTED_COMMANDS = %w[orders inventories]
 
 def main(argv)
   global_options = parse_global_options(argv)
@@ -14,6 +14,8 @@ def main(argv)
   case subcommand
   when "orders"
     orders global_options, argv
+  when "inventories"
+    inventories global_options, argv
   end
 end
 
@@ -27,6 +29,11 @@ end
 
 def parse_global_options(argv)
   parse_options(argv) {|opt|
+    opt.banner = "Usage:\n" + SUPPORTED_COMMANDS.collect {|command|
+      "    #{opt.program_name} [global options] #{command} [options]"
+    }.join("\n")
+    opt.version = Futureshop::VERSION
+    opt.separator "Global options:"
     opt.on "--verbose" do
       $VERBOSE = true
     end
@@ -36,38 +43,38 @@ end
 def orders(global_options, argv)
   options = {format: "json"}
   options.update(parse_options(argv) {|opt|
-    opt.on "-f", "--format=FORMAT", ["json", "csv"]
-    opt.on "--order-date-start=DATE", Time
-    opt.on "--order-date-end=DATE", Time
+    formats = %w[json csv]
+    opt.on "-f", "--format=FORMAT", ["json", "csv"], "Output format. Available: #{formats.join(', ')}"
+    opt.on "--order-date-start=YYYY-MM-DD", Time, "Retrieve orders whose date is newer than or equal to argument."
+    opt.on "--order-date-end=YYYY-MM-DD", Time, "Retrieve orders whose date is older than or equal to argument."
   })
-  Futureshop.orders(order_date_start: options["order-date-start"], order_date_end: options["order-date-end"], format: options["format"])
+  Futureshop.orders(order_date_start: options[:"order-date-start"], order_date_end: options[:"order-date-end"], format: options[:format])
 end
 
-def client
-  Futureshop::Client.new(
-    shop_key: ENV["FUTURESHOP_SHOP_KEY"],
-    client_id: ENV["FUTURESHOP_CLIENT_ID"],
-    client_secret: ENV["FUTURESHOP_CLIENT_SECRET"],
-    api_domain: ENV["FUTURESHOP_API_DOMAIN"]
-  )
-end
+def inventories(global_options, argv)
+  require "futureshop/inventory"
 
-def aggregate_headers(obj, headers = [])
-  obj.each_pair do |key, value|
-    unless %w[buyerInfo addressInfo shippingInfo shipmentList productList].include? key
-      headers << key
-    end
-    case value
-    when Hash
-      headers.concat aggregate_headers(value).collect {|header| "#{key}.#{header}"}
-    when Array
-      sample = value[0]
-      if sample
-        headers.concat aggregate_headers(sample).collect {|header| "#{key}.#{header}"}
-      end
+  options = {
+    type: ["regular"],
+    product_no: [],
+    jan_code: []
+  }
+  options = options.update(parse_options(argv) {|opt|
+    opt.on "--type=TYPE", Array, "Type. Available: regular, preorder, planned, realstore"
+    opt.on "--create-date-start=DATE", Time, "Retrieve products whose registration date is newer than or equal to argument."
+    opt.on "--create-date-end=DATE", Time, "Retrieve products whose registration date is older than or equal to argument."
+    opt.on "--product-no=NUMBER", Array, "Product number."
+    opt.on "--jan-code=CODE", Array, "JAN code."
+  })
+  if options[:type]
+    unknown_types = options[:type].select {|type| ! %w[regular preorder planned realstore].include?(type)}
+    unless unknown_types.empty?
+      raise "Unknown type(s): #{unknown_types.join(', ')}"
     end
   end
-  headers
+  Futureshop::Inventory.each types: options[:type].collect(&:to_sym), create_date_start: options[:"create-date-start"], create_date_end: options[:"create-date-end"], product_no: options[:"product-no"], jan_code: options[:"jan-code"] do |inventory|
+    puts inventory.to_json
+  end
 end
 
 main ARGV

data/futureshop.gemspec

@@ -8,13 +8,13 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "futureshop APIv2 client and tools"
   spec.description   = "futureshop APIv2 client and tools"
-  spec.homepage      = "https://gitlab.com/KitaitiMakoto/futuresohp"
-  spec.required_ruby_version = ">= 3.0.0"
+  spec.homepage      = "https://gitlab.com/KitaitiMakoto/futureshop"
+  spec.required_ruby_version = ">= 2.7.0"
   spec.license       = "AGPL-3.0-or-later"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "https://gitlab.com/KitaitiMakoto/futuresohp/-/blob/main/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://gitlab.com/KitaitiMakoto/futureshop/-/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/futureshop/client.rb

@@ -42,10 +42,7 @@ module Futureshop
       }
     end
 
-    def request(method, path = "/", params: {}, data: {})
-      raise "Unsupported method: #{method}" unless [:get, :post].include?(method)
-      query = params.empty? ? nil : build_query(params)
-      uri = URI::HTTPS.build(host: @api_domain, port: @port, path: path, query: query)
+    def request_by_uri(method, uri, data: {})
       request = Net::HTTP.const_get(method.capitalize).new(uri)
       headers.each_pair do |field, value|
         request[field] = value
@@ -56,6 +53,13 @@ module Futureshop
       JSON.parse(response.body)
     end
 
+    def request(method, path = "/", params: {}, data: {})
+      raise "Unsupported method: #{method}" unless [:get, :post].include?(method)
+      query = params.empty? ? nil : build_query(params)
+      uri = URI::HTTPS.build(host: @api_domain, port: @port, path: path, query: query)
+      request_by_uri(method, uri, data: data)
+    end
+
     def get(path = "/", params: {})
       request(:get, path, params: params)
     end
@@ -78,12 +82,13 @@ module Futureshop
       res = get("/admin-api/v1/shipping", params: params)
       yield res["orderList"]
 
-      nextUrl = res["nextUrl"]
-      while nextUrl
+      next_url = res["nextUrl"]
+      while next_url
         sleep INTERVAL
-        res = get(nextUrl, params: params) # TODO: check spec to see whether it's okay to pass params in this form
+        url = URI.parse(next_url)
+        res = request_by_uri(:get, url)
         yield res["orderList"]
-        nextUrl = res["nextUrl"]
+        next_url = res["nextUrl"]
       end
     end
 

data/lib/futureshop/inventory.rb

@@ -0,0 +1,51 @@
+module Futureshop
+  class Inventory
+    class << self
+      def each_batch(types: [:regular], create_date_start: nil, create_date_end: nil, product_no: [], jan_code: [])
+        params = {
+          types: types,
+          product_no: product_no,
+          jan_code: jan_code
+        }
+        params[:create_date_start] = create_date_start.strftime("%FT%T") if create_date_start
+        params[:create_date_end] = create_date_end.strftime("%FT%T") if create_date_end
+        res = client.get("/admin-api/v1/inventory", params: params)
+        yield res["productList"]
+
+        next_url = res["nextUrl"]
+        while next_url
+          sleep Client::INTERVAL
+          url = URI.parse(next_url)
+          res = client.request_by_uri(:get, url)
+          yield res["productList"]
+          next_url = res["nextUrl"]
+        end
+      end
+
+      def each(**args)
+        return enum_for(__method__, **args) unless block_given?
+
+        each_batch **args do |inventories|
+          inventories.each do |inventory|
+            yield inventory
+          end
+        end
+      end
+
+      def all(**args)
+        return each.to_a
+      end
+
+      private
+
+      def client
+        @client ||= Futureshop::Client.new(
+          shop_key: ENV["FUTURESHOP_SHOP_KEY"],
+          client_id: ENV["FUTURESHOP_CLIENT_ID"],
+          client_secret: ENV["FUTURESHOP_CLIENT_SECRET"],
+          api_domain: ENV["FUTURESHOP_API_DOMAIN"]
+        )
+      end
+    end
+  end
+end

data/lib/futureshop/version.rb

@@ -1,3 +1,3 @@
 module Futureshop
-  VERSION = "0.1.2"
+  VERSION = "0.1.6"
 end

data/lib/futureshop.rb

@@ -25,33 +25,40 @@ module Futureshop
             raise "Multiple shipmentList. orderNo: #{order["orderNo"]}" if order["shipmentList"].length > 1
             order["shipmentList"].each do |shipment|
               shipment["productList"].each do |product|
-                csv << order.each_value.with_object([]) {|value, values|
+                csv << order.each_pair.with_object([]) {|(key, value), values|
                   case value
                   when Hash
                     value.each_value do |v|
                       values << v
                     end
                   when Array
-                    # only shipmentList is an Array and its length is 0
-                    shipment.each_value do |v|
-                      case v
-                      when Hash
-                        v.each_value do |ov|
-                          values << ov
-                        end
-                      when Array
-                        product.each_pair do |k, v|
-                          case k
-                          when "optionPriceList"
-                            v = v.collect {|optionPrice| "#{optionPrice['name']}:#{optionPrice['selectionName']}(#{optionPrice['price']})"}.join("/")
-                          when "optionList"
-                            v = v.collect {|option| [option["name"], option["selectionItem"]].join(":")}.join(",")
+                    case key
+                    when "shipmentList"
+                      # shipmentList's length is 1
+                      shipment.each_value do |v|
+                        case v
+                        when Hash
+                          v.each_value do |ov|
+                            values << ov
+                          end
+                        when Array
+                          product.each_pair do |k, v|
+                            case k
+                            when "optionPriceList"
+                              v = v.collect {|optionPrice| "#{optionPrice['name']}:#{optionPrice['selectionName']}(#{optionPrice['price']})"}.join("/")
+                            when "optionList"
+                              v = v.collect {|option| [option["name"], option["selectionItem"]].join(":")}.join(",")
+                            end
+                            values << v
                           end
+                        else
                           values << v
                         end
-                      else
-                        values << v
                       end
+                    when "couponList"
+                      values << value.collect {|coupon| [coupon["id"], coupon["name"]].join(":")}.join("/")
+                    else
+                      raise "Unknown array field: #{key}"
                     end
                   else
                     values << value
@@ -60,6 +67,8 @@ module Futureshop
               end
             end
           end
+        else
+          raise RuntimeError("unsupported format: #{format}")
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: futureshop
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.6
 platform: ruby
 authors:
 - Kitaiti Makoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -73,14 +73,15 @@ files:
 - futureshop.gemspec
 - lib/futureshop.rb
 - lib/futureshop/client.rb
+- lib/futureshop/inventory.rb
 - lib/futureshop/version.rb
-homepage: https://gitlab.com/KitaitiMakoto/futuresohp
+homepage: https://gitlab.com/KitaitiMakoto/futureshop
 licenses:
 - AGPL-3.0-or-later
 metadata:
-  homepage_uri: https://gitlab.com/KitaitiMakoto/futuresohp
-  source_code_uri: https://gitlab.com/KitaitiMakoto/futuresohp
-  changelog_uri: https://gitlab.com/KitaitiMakoto/futuresohp/-/blob/main/CHANGELOG.md
+  homepage_uri: https://gitlab.com/KitaitiMakoto/futureshop
+  source_code_uri: https://gitlab.com/KitaitiMakoto/futureshop
+  changelog_uri: https://gitlab.com/KitaitiMakoto/futureshop/-/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -89,14 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: futureshop APIv2 client and tools