itc-autoingest 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/README.md CHANGED
@@ -1,2 +1,69 @@
1
1
 
2
- http://www.apple.com/itunesnews/docs/AppStoreReportingInstructions.pdf
2
+ 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.
3
+
4
+ For more information about ITC reports see this [pdf](http://www.apple.com/itunesnews/docs/AppStoreReportingInstructions.pdf).
5
+
6
+ ## Features
7
+
8
+ * Supports Sales reports, Daily/Weekly reports and Summary/Opt-in reports (see above pdf for more information on each type of report)
9
+ * Returns report as a hash of the information in the downloaded report file
10
+ * Handy command line tool that can be used to output tab delimited information or as an example of how to use the gem
11
+
12
+ ## Instructions
13
+
14
+ The command line tool uses the following syntax:
15
+
16
+ ``` text
17
+ itc_autoingest <username> <password> <vendorid> <report type> <date type> <report subtype> <date>
18
+ ```
19
+ * username - your itunes connect username
20
+ * password - your itunes connect password
21
+ * vendorid - your itunes connect vendor id
22
+ * report type - the only type currently supported is Sales
23
+ * date type - there are two date types supported: Daily and Weekly
24
+ * report subtype - there are two subtypes supported: Summary and Opt-In
25
+ * date - the timeframe for the report in yyyymmdd format
26
+
27
+ The gem has the following methods available:
28
+
29
+ * daily_sales_summary_report(reportdate)
30
+ * weekly_sales_summary_report(reportdate)
31
+ * daily_sales_optin_report(reportdate)
32
+ * weekly_sales_optin_report(reportdate)
33
+
34
+ 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.
35
+
36
+ ## Examples
37
+
38
+ Using the command line utility will look something like this:
39
+
40
+ ``` text
41
+ itc_autoingest user pass 50050992 Sales Daily Summary 20110901
42
+ ```
43
+
44
+ The following example would result in **report** being filled with a hash of report data for the given date:
45
+
46
+ ``` rb
47
+ require "itc_autoingest"
48
+
49
+ itca = ITCAutoingest::ITCAutoingest.new(username, password, vendorid)
50
+ report = itca.daily_sales_summary_report('20110901')
51
+
52
+ puts report
53
+ ```
54
+
55
+ ## Copyright
56
+
57
+ Copyright (C) 2011 Carson McDonald - [@casron](http://twitter.com/casron)
58
+
59
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
60
+ associated documentation files (the “Software”), to deal in the Software without restriction, including without
61
+ limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
62
+ and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
63
+
64
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
65
+
66
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
67
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM,
68
+ DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
69
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
7
7
  s.version = ITCAutoingest::VERSION
8
8
  s.authors = ["Carson McDonald"]
9
9
  s.email = ["carson@ioncannon.net"]
10
- s.homepage = "http://github.com/carsonmcdonald/itc-autoingest"
10
+ s.homepage = "http://github.com/carsonmcdonald/itc-autoingest-gem"
11
11
  s.summary = %q{ITC Autoingest is a gem for fetching iTunes connect reports.}
12
12
  s.description = %q{This library makes it easy to fetch iTunes connect reports using the official autoingest system.}
13
13
 
@@ -1,3 +1,3 @@
1
1
  module ITCAutoingest
2
- VERSION = "1.0.0"
2
+ VERSION = "1.0.1"
3
3
  end
metadata CHANGED
@@ -2,7 +2,7 @@
2
2
  name: itc-autoingest
3
3
  version: !ruby/object:Gem::Version
4
4
  prerelease:
5
- version: 1.0.0
5
+ version: 1.0.1
6
6
  platform: ruby
7
7
  authors:
8
8
  - Carson McDonald
@@ -10,8 +10,7 @@ autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
12
 
13
- date: 2011-09-19 00:00:00 -04:00
14
- default_executable:
13
+ date: 2011-09-19 00:00:00 Z
15
14
  dependencies:
16
15
  - !ruby/object:Gem::Dependency
17
16
  name: httparty
@@ -42,8 +41,7 @@ files:
42
41
  - itc_autoingest.gemspec
43
42
  - lib/itc_autoingest.rb
44
43
  - lib/itc_autoingest/version.rb
45
- has_rdoc: true
46
- homepage: http://github.com/carsonmcdonald/itc-autoingest
44
+ homepage: http://github.com/carsonmcdonald/itc-autoingest-gem
47
45
  licenses: []
48
46
 
49
47
  post_install_message:
@@ -66,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
66
64
  requirements: []
67
65
 
68
66
  rubyforge_project: itc-autoingest
69
- rubygems_version: 1.6.2
67
+ rubygems_version: 1.8.10
70
68
  signing_key:
71
69
  specification_version: 3
72
70
  summary: ITC Autoingest is a gem for fetching iTunes connect reports.