apple_reporter 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa91e538a8469cc35b2bc53534febcc12944b9af
-  data.tar.gz: df6b6655e7a3876fd5ce675961c78dfa72f149a7
+  metadata.gz: f9609786844909fdf453e6429dc6ebe596eada77
+  data.tar.gz: cba7b3351e012f9d7f6c32723c888a0ca4919436
 SHA512:
-  metadata.gz: '09568ebf9a69689919895cd4abb828174989418d7c2de0095ef9dc39c02c16b959a25efbfc7e04379ccacb74e367a4cf8412e3483655b543791379d8d59310e5'
-  data.tar.gz: 43c0e8a9c184b1be2bf1429600855e9394b5f814e813b3d82fc64beeceb70bd30c7e11fcc8b638cce7eff056cc16c94c6f4a579912baacf648c6701af809739c
+  metadata.gz: 8d382919f316fe29ba521cb777d4d00a76d09df85f0168ed1ccd2e7304bab29ebe2755d15b028dd5d3d96f984c92c542c87b50065e53c9ab2a9986848e481b8e
+  data.tar.gz: b1d1692fedb41e54e7fe7409cdf1db676ac09d9d82f5175948d07e5e8cff1f6b14189d49779cf962d06b24eae614047062feb02ca6781fa3fb0565892a54470d

data/README.md

@@ -28,33 +28,45 @@ Or install it yourself as:
 
 ### Sales
 
-- getReport
+- get_report
 
 ```
 reporter = AppleReporter::Sale.new(user_id: 'your user id', access_token: 'your access token')
-report = reporter.getReport(
-  {
-    vendor_number: 'your vender id',
-    report_type: 'Sales',
-    report_sub_type: 'Summary',
-    date_type: 'Daily',
-    date: '20161212'
-  }
+report = reporter.get_report(
+  vendor_number: 'your vender id',
+  report_type: 'Sales',
+  report_sub_type: 'Summary',
+  date_type: 'Daily',
+  date: '20161212'
 )
 ```
 ### Finance
 
-- getReport
+- get_report
 ```
 reporter = AppleReporter::Finance.new(user_id: 'your user id', access_token: 'your access token')
-report = reporter.getReport(
-  {
-    vendor_number: 'your vender id',
-    region_code: 'US',
-    report_type: 'Financial',
-    fiscal_year: '2016',
-    fiscal_period: '02'
-  }
+report = reporter.get_report(
+  vendor_number: 'your vender id',
+  region_code: 'US',
+  report_type: 'Financial',
+  fiscal_year: '2016',
+  fiscal_period: '02'
+)
+```
+
+- get_report with version
+```
+reporter = AppleReporter::Finance.new(
+  user_id: 'your user id', 
+  access_token: 'your access token'
+  version: '1_1'
+)
+report = reporter.get_report(
+  vendor_number: 'your vender id',
+  region_code: 'US',
+  report_type: 'Financial',
+  fiscal_year: '2016',
+  fiscal_period: '02'
 )
 ```
 

data/lib/apple_reporter/finance.rb

@@ -1,49 +1,46 @@
 module AppleReporter
   class Finance < Reporter
-
-    # getAccounts
+    # accounts
     #
     # Usage:
-    #   report = reporter.getAccounts
-    def getAccounts
+    #   report = reporter.accounts
+    def accounts
       fetch(@config[:finance_path], 'Finance.getAccounts')
     end
 
-    # getStatus
+    # status
     #
     # Usage:
-    #   report = reporter.getStatus
-    def getStatus
+    #   report = reporter.status
+    def status
       fetch(@config[:finance_path], 'Finance.getStatus')
     end
 
-    # getVendorsAndRegions
+    # vendors_and_regions
     #
     # Usage:
-    #   report = reporter.getVendorsAndRegions
-    def getVendorsAndRegions
+    #   report = reporter.vendors_and_regions
+    def vendors_and_regions
       fetch(@config[:finance_path], 'Finance.getVendorsAndRegions')
     end
 
-    # getReport
+    # get_report
     # Refer to: https://help.apple.com/itc/appsreporterguide/
     #
     # Usage:
     #
-    # report = reporter.getReport(
-    #   {
-    #     vendor_number: 'myVendor',
-    #     region_code: 'US',
-    #     report_type: 'Financial',
-    #     fiscal_year: '2016',
-    #     fiscal_period: '02'
-    #   }
+    # report = reporter.get_report(
+    #   vendor_number: 'myVendor',
+    #   region_code: 'US',
+    #   report_type: 'Financial',
+    #   fiscal_year: '2016',
+    #   fiscal_period: '02'
     # )
-    def getReport(params = {})
+    def get_report(params = {})
       fetch(@config[:finance_path], (['Finance.getReport'] + [params.slice(:vendor_number, :region_code, :report_type, :fiscal_year, :fiscal_period).values.join(',')]).join(', '))
     end
 
-    def getVersion
+    def version
       @config[:version]
     end
   end

data/lib/apple_reporter/reporter.rb

@@ -11,7 +11,7 @@ module AppleReporter
         sales_path: '/sales/v1',
         finance_path: '/finance/v1',
         mode: 'Robot.XML',
-        version: '1.0',
+        version: '1_0'
       }.merge(config)
     end
 
@@ -31,13 +31,13 @@ module AppleReporter
       payload[:account] = @config[:account] if @config[:account]
 
       response = RestClient.post("#{ENDPOINT}#{api_path}", "jsonRequest=#{payload.to_json}", headers)
-      handleResponse(@config[:mode], response)
+      handle_response(@config[:mode], response)
     rescue RestClient::ExceptionWithResponse => err
-      handleResponse(@config[:mode], err.response)
+      handle_response(@config[:mode], err.response)
     end
 
     #
-    def handleResponse(mode, response)
+    def handle_response(mode, response)
       if response.code == 200
         if response.headers[:content_type] == 'application/a-gzip'
           io = StringIO.new(response.body)

data/lib/apple_reporter/sale.rb

@@ -1,51 +1,47 @@
 module AppleReporter
   class Sale < Reporter
-
-    # getAccounts
+    # accounts
     #
     # Usage:
-    #   report = reporter.getAccounts
-    def getAccounts
+    #   report = reporter.accounts
+    def accounts
       fetch(@config[:sales_path], 'Sales.getAccounts')
     end
 
-    # getStatus
+    # status
     #
     # Usage:
-    #   report = reporter.getStatus
-    def getStatus
+    #   report = reporter.status
+    def status
       fetch(@config[:sales_path], 'Sales.getStatus')
     end
 
-    # getVendors
+    # vendors
     #
     # Usage:
-    #   report = reporter.getVendors
-    def getVendors
+    #   report = reporter.vendors
+    def vendors
       fetch(@config[:sales_path], 'Sales.getVendors')
     end
 
-    def getVersion
+    def version
       @config[:version]
     end
 
-    # getReport
+    # get_report
     # Refer to: https://help.apple.com/itc/appsreporterguide/
     #
     # Usage:
     #
-    # report = reporter.getReport(
-    #   {
-    #     vendor_number: 'myVendor',
-    #     report_type: 'Sales',
-    #     report_sub_type: 'Summary',
-    #     date_type: 'Daily',
-    #     date: '20161212'
-    #   }
+    # report = reporter.get_report(
+    #   vendor_number: 'myVendor',
+    #   report_type: 'Sales',
+    #   report_sub_type: 'Summary',
+    #   date_type: 'Daily',
+    #   date: '20161212'
     # )
-    def getReport(params = {})
+    def get_report(params = {})
       fetch(@config[:sales_path], (['Sales.getReport'] + [params.slice(:vendor_number, :report_type, :report_sub_type, :date_type, :date).values.join(',')]).join(', '))
     end
-
   end
 end

data/lib/apple_reporter/version.rb

@@ -1,3 +1,3 @@
 module AppleReporter
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apple_reporter
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Dean Lin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2017-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client