apple_reporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8ab132347782703fdf20678bdd0bc0abb8f5a63
+  data.tar.gz: 51dc4e09752897b12f8a0ad9101906430517bc57
+SHA512:
+  metadata.gz: 0e8024bb5f39bbae6873c02ad9c23fe6fa507db5654c626eff08fea572937430930299ec968f3662faf065bcd7b61f12d5c3d3eac9ee3d84a6726a7f75ca4507
+  data.tar.gz: 5b551612e3eefef51dfedafd6f69f7d1921bb7c23675234a3d30a43e7de3f679acf61a3f6873d5a028b21840f18af6a851faa32087089ba84ab04a0a7f79daed

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format=documentation
+--exclude-pattern='spec/integration/**/*_spec.rb'

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  Include:
+    - Guardfile
+    - Rakefile
+  Exclude:
+    - .bundle/**/*
+    - bin/**/*
+    - vendor/**/*
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,71 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-02-01 08:14:39 -0600 using RuboCop version 0.34.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Lint/NestedMethodDefinition:
+  Exclude:
+    - 'lib/hashie/extensions/indifferent_access.rb'
+
+# Offense count: 10
+Metrics/AbcSize:
+  Max: 29
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 200
+
+# Offense count: 8
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 239
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 170
+
+# Offense count: 17
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 28
+
+# Offense count: 6
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Offense count: 2
+Style/CaseEquality:
+  Exclude:
+    - 'lib/hashie/hash.rb'
+
+# Offense count: 34
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 11
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/hashie/dash.rb'
+    - 'lib/hashie/extensions/dash/indifferent_access.rb'
+    - 'lib/hashie/extensions/method_access.rb'
+    - 'lib/hashie/mash.rb'
+    - 'spec/hashie/extensions/coercion_spec.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues.
+Style/HashSyntax:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+Style/RegexpLiteral:
+  Exclude:
+    - 'Guardfile'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dean.lin@iscreen.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in apple_reporter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dean Lin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# AppleReporter
+
+This is Ruby Version <b>iTunes Connect Reporter</b>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apple_reporter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apple_reporter
+
+## Usage
+
+
+### Sales
+
+- getReport
+
+```
+reporter = AppleReporter::Sale.new(user_id: 'iscreen', password: 'your password')
+report = reporter.getReport(
+    {
+    vendor_number: 'myVendor',
+    report_type: 'Sales',
+    report_sub_type: 'Summary',
+    date_type: 'Daily',
+    date: '20161212'
+    }
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iscreen/apple_reporter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/apple_reporter.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apple_reporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'apple_reporter'
+  spec.version       = AppleReporter::VERSION
+  spec.authors       = ['Dean Lin']
+  spec.email         = ['iscreen@gmail.com']
+
+  spec.summary       = %q{Apple iTunes Connect Reporter}
+  spec.description   = %q{Apple iTunes Connect Reporter}
+  spec.homepage      = 'https://github.com/iscreen/apple_reporter.git'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'Set to "https://github.com/iscreen/apple_reporter.git"'
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('nokogiri')
+  spec.add_dependency('activesupport')
+  spec.add_dependency('rest-client')
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'activesupport', '~> 4.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apple_reporter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/apple_reporter/finance.rb

@@ -0,0 +1,50 @@
+module AppleReporter
+  class Finance < Reporter
+
+    # getAccounts
+    #
+    # Usage:
+    #   report = reporter.getAccounts
+    def getAccounts
+      fetch(@config[:finance_path], 'Finance.getAccounts')
+    end
+
+    # getStatus
+    #
+    # Usage:
+    #   report = reporter.getStatus
+    def getStatus
+      fetch(@config[:finance_path], 'Finance.getStatus')
+    end
+
+    # getVendorsAndRegions
+    #
+    # Usage:
+    #   report = reporter.getVendorsAndRegions
+    def getVendorsAndRegions
+      fetch(@config[:finance_path], 'Finance.getVendorsAndRegions')
+    end
+
+    # getReport
+    # 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'
+    #   }
+    # )
+    def getReport(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
+      @config[:version]
+    end
+  end
+end

data/lib/apple_reporter/reporter.rb

@@ -0,0 +1,60 @@
+module AppleReporter
+  class Reporter
+    ENDPOINT = 'https://reportingitc-reporter.apple.com/reportservice'
+
+    #
+    # Usage:
+    # reporter = Apple::Reporter::Sale.new(user_id: 'iscreen', password: 'secret', account: 'myAccount')
+    #
+    def initialize(config = {})
+      @config = {
+        sales_path: '/sales/v1',
+        finance_path: '/finance/v1',
+        mode: 'Robot.XML',
+        version: '1.0',
+      }.merge(config)
+    end
+
+    private
+
+    def fetch(api_path, params)
+      headers = {
+        'Content-Type' => 'application/x-www-form-urlencoded'
+      }
+      payload = {
+        userid: @config[:user_id],
+        password: @config[:password],
+        version: @config[:version],
+        mode: @config[:mode],
+        queryInput: "[p=Reporter.properties, #{params}]"
+      }
+      payload[:account] = @config[:account] if @config[:account]
+
+      response = RestClient.post("#{ENDPOINT}#{api_path}", "jsonRequest=#{payload.to_json}", headers)
+      handleResponse(@config[:mode], response)
+    rescue RestClient::ExceptionWithResponse => err
+      handleResponse(@config[:mode], err.response)
+    end
+
+    #
+    def handleResponse(mode, response)
+      if response.code == 200
+        if response.headers[:content_type] == 'application/a-gzip'
+          io = StringIO.new(response.body)
+          gz = Zlib::GzipReader.new(io)
+          return gz.readlines.join
+        else
+          doc = Nokogiri::XML(response.body)
+          return Hash.from_xml(doc.to_s)
+        end
+      end
+
+      if mode == 'Robot.XML'
+        doc = Nokogiri::XML(response.body)
+        return Hash.from_xml(doc.to_s)
+      end
+
+      return response.body
+    end
+  end
+end

data/lib/apple_reporter/sale.rb

@@ -0,0 +1,51 @@
+module AppleReporter
+  class Sale < Reporter
+
+    # getAccounts
+    #
+    # Usage:
+    #   report = reporter.getAccounts
+    def getAccounts
+      fetch(@config[:sales_path], 'Sales.getAccounts')
+    end
+
+    # getStatus
+    #
+    # Usage:
+    #   report = reporter.getStatus
+    def getStatus
+      fetch(@config[:sales_path], 'Sales.getStatus')
+    end
+
+    # getVendors
+    #
+    # Usage:
+    #   report = reporter.getVendors
+    def getVendors
+      fetch(@config[:sales_path], 'Sales.getVendors')
+    end
+
+    def getVersion
+      @config[:version]
+    end
+
+    # getReport
+    # 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'
+    #   }
+    # )
+    def getReport(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

@@ -0,0 +1,3 @@
+module AppleReporter
+  VERSION = "0.1.0"
+end

data/lib/apple_reporter.rb

@@ -0,0 +1,12 @@
+require 'active_support/all'
+require 'nokogiri'
+require 'rest-client'
+
+require 'apple_reporter/version'
+require 'apple_reporter/reporter'
+require 'apple_reporter/sale'
+require 'apple_reporter/finance'
+
+module AppleReporter
+  raise "Cannot require AppleReporter, unsupported engine '#{RUBY_ENGINE}'" unless RUBY_ENGINE == "ruby"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: apple_reporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Lin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: activesupport
+  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: rest-client
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Apple iTunes Connect Reporter
+email:
+- iscreen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apple_reporter.gemspec
+- bin/console
+- bin/setup
+- lib/apple_reporter.rb
+- lib/apple_reporter/finance.rb
+- lib/apple_reporter/reporter.rb
+- lib/apple_reporter/sale.rb
+- lib/apple_reporter/version.rb
+homepage: https://github.com/iscreen/apple_reporter.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Apple iTunes Connect Reporter
+test_files: []