itc-autoingest 1.0.0 → 1.0.1

data/README.md

@@ -1,2 +1,69 @@
 
-http://www.apple.com/itunesnews/docs/AppStoreReportingInstructions.pdf
+ITCAutoingest is a gem for gathering reports out of iTunes connect. It uses the ITC autoingest service to download and parse the reports and **does not** try to scrape the iTunes connect website.
+
+For more information about ITC reports see this [pdf](http://www.apple.com/itunesnews/docs/AppStoreReportingInstructions.pdf).
+
+## Features
+
+* Supports Sales reports, Daily/Weekly reports and Summary/Opt-in reports (see above pdf for more information on each type of report)
+* Returns report as a hash of the information in the downloaded report file
+* Handy command line tool that can be used to output tab delimited information or as an example of how to use the gem
+
+## Instructions
+
+The command line tool uses the following syntax:
+
+``` text
+itc_autoingest <username> <password> <vendorid> <report type> <date type> <report subtype> <date>
+```
+* username - your itunes connect username
+* password - your itunes connect password
+* vendorid - your itunes connect vendor id
+* report type - the only type currently supported is Sales
+* date type - there are two date types supported: Daily and Weekly
+* report subtype - there are two subtypes supported: Summary and Opt-In
+* date - the timeframe for the report in yyyymmdd format
+
+The gem has the following methods available:
+
+* daily_sales_summary_report(reportdate)
+* weekly_sales_summary_report(reportdate)
+* daily_sales_optin_report(reportdate)
+* weekly_sales_optin_report(reportdate)
+
+A hash is returned from each of these calls and will contain a report item with an array of hashed report data or an error item that contains an error from the reporting system.
+
+## Examples
+
+Using the command line utility will look something like this:
+
+``` text
+itc_autoingest user pass 50050992 Sales Daily Summary 20110901
+```
+
+The following example would result in **report** being filled with a hash of report data for the given date:
+
+``` rb
+require "itc_autoingest"
+
+itca = ITCAutoingest::ITCAutoingest.new(username, password, vendorid)
+report = itca.daily_sales_summary_report('20110901')
+
+puts report
+```
+
+## Copyright
+
+Copyright (C) 2011 Carson McDonald - [@casron](http://twitter.com/casron)
+
+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 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/itc_autoingest.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = ITCAutoingest::VERSION
   s.authors     = ["Carson McDonald"]
   s.email       = ["carson@ioncannon.net"]
-  s.homepage    = "http://github.com/carsonmcdonald/itc-autoingest"
+  s.homepage    = "http://github.com/carsonmcdonald/itc-autoingest-gem"
   s.summary     = %q{ITC Autoingest is a gem for fetching iTunes connect reports.}
   s.description = %q{This library makes it easy to fetch iTunes connect reports using the official autoingest system.}
 

data/lib/itc_autoingest/version.rb

@@ -1,3 +1,3 @@
 module ITCAutoingest
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -2,7 +2,7 @@
 name: itc-autoingest
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Carson McDonald
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-19 00:00:00 -04:00
-default_executable: 
+date: 2011-09-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
@@ -42,8 +41,7 @@ files:
 - itc_autoingest.gemspec
 - lib/itc_autoingest.rb
 - lib/itc_autoingest/version.rb
-has_rdoc: true
-homepage: http://github.com/carsonmcdonald/itc-autoingest
+homepage: http://github.com/carsonmcdonald/itc-autoingest-gem
 licenses: []
 
 post_install_message: 
@@ -66,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: itc-autoingest
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: ITC Autoingest is a gem for fetching iTunes connect reports.