app_store_info 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b373ddd16194c0c7cc275cf7c3d8cc626ccca9b9
-  data.tar.gz: 19751924943f11933dc977b6ce5f11c3a4e256f9
+  metadata.gz: 0b0050fc08b2d1862909ccab9dfddee394a735c0
+  data.tar.gz: 90546fd08bdb5673ffd93e3f53ae445d9474b5a4
 SHA512:
-  metadata.gz: df93c102915029dda150226ed17f5cd74282895d58c490eb5cfecb4d6a6fc36c5a35023535be2cf5ffa8b103006a7f78b8684453f692ab1462eeb81d06c728e7
-  data.tar.gz: 0867b3e3df2dad6d59373574a8d2aba23e0353f22eb85b537230461d98807855cf97cf7b2b5ac0c4cd774cb6e90c99679337e86a3830c41a4279ec99d008df25
+  metadata.gz: 89163dd9da0430aaff1e4f000aec73ce8891c337a3f50d184a8d00ddc66c0074acc37f12a5bd9d4709a706d7fdccf3527c88045ba927baeca0a3be28d4b9ae63
+  data.tar.gz: 112b10887926332f345c7bfc7150ac1cf13d104d3e7ea63621198e161931665ce498999ef05cdb971322bb9b4157291b83dbeba80c0496ad9d1e2f7603c80a20

data/.gitignore

@@ -1,3 +1,4 @@
+*.gem
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
+  - 1.9.3
+  - 2.0.0
   - 2.2.2
 before_install: gem install bundler -v 1.10.6

data/README.md

@@ -1,8 +1,10 @@
+[![Build Status](https://travis-ci.org/rikas/app_store_info.svg)](https://travis-ci.org/rikas/app_store_info)
+
 # AppStoreInfo
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/app_store_info`. To experiment with that code, run `bin/console` for an interactive prompt.
+Get details about any app in the Apple App Store. This gem uses iTunes lookup method to get information about apps. (i.e. https://itunes.apple.com/us/lookup?id=343200656).
 
-TODO: Delete this and the text above, and describe your gem
+Compatible with ruby >= 1.9.3
 
 ## Installation
 
@@ -22,7 +24,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You first have to read the app details, using the store URL or directly with the ID:
+
+```ruby
+app = AppStoreInfo.read_url('https://itunes.apple.com/gb/app/angry-birds/id343200656?mt=8')
+app = AppStoreInfo.read(343200656)
+app = AppStoreInfo.read(343200656, 'gb') # You can give a particular region or it will use 'us'
+```
+
+Then you have some attributes that can be read easily:
+
+```ruby
+app.id                  # => 343200656
+app.name                # => "Angry Birds"
+app.url                 # => "http://www.angrybirds.com/"
+app.average_user_rating # => 4.5
+app.user_rating_count   # => 222131
+app.genre_ids           # => ["6014", "7003", "6016", "7001"]
+app.price               # => 0.79
+app.currency            # => "GBP"
+app.supported_devices   # => ["iPhone-3GS", "iPhone4", "iPodTouchFourthGen", ...]
+app.company             # => "Rovio Entertainment Ltd"
+app.description         # => "Use the unique powers of the Angry Birds to destroy ...
+app.minimum_os_version  # => "6.0"
+app.features            # => ["gameCenter"]
+```
+
+You can also check if the app is Universal:
+
+```ruby
+app.universal? # => false
+```
+
+Last, you can check the details about the latest version of the app:
+```ruby
+current_version = app.current_version
+
+current_version.average_user_rating # => 4.0
+current_version.user_rating_count   # => 191
+current_version.number              # => "5.2.0"
+current_version.release_notes       # => "We popped some pesky bugs!"
+```
+
+If you need to get the genre names there's an helper method for that:
+```ruby
+app.genre_names # => ["Games", "Action", "Arcade", "Entertainment"]
+```
+
+Keep in mind that the information can be localized if you request for a particular region
+information. Ratings, currency, price etc. can change.
+
 
 ## Development
 
@@ -32,10 +83,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/app_store_info.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rikas/app_store_info.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/app_store_info/app.rb

@@ -1,4 +1,5 @@
 require 'app_store_info/json_accessors'
+require 'ostruct'
 
 module AppStoreInfo
   class App
@@ -6,7 +7,7 @@ module AppStoreInfo
 
     attr_reader :current_version
 
-    json_accessors id: 'trackId', name: 'trackCensoredName', domain: 'sellerUrl',
+    json_accessors id: 'trackId', name: 'trackCensoredName', url: 'sellerUrl',
                    average_user_rating: 'averageUserRating', user_rating_count: 'userRatingCount',
                    genre_ids: 'genreIds', price: 'price', currency: 'currency',
                    supported_devices: 'supportedDevices', company: 'artistName',
@@ -26,7 +27,7 @@ module AppStoreInfo
     end
 
     def genre_names
-      @genre_ids.map { |genre| GENRES[genre.to_i] }
+      @genre_ids.map { |genre| AppStoreInfo::GENRES[genre.to_i] }
     end
 
     def store_icon_url

data/lib/app_store_info/regions.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 module AppStoreInfo
   class Regions
     # All the available regions (taken from https://developer.apple.com/library/ios/documentation/
@@ -22,7 +23,7 @@ module AppStoreInfo
       'IS' => 'Iceland', 'IT' => 'Italy', 'JM' => 'Jamaica', 'JO' => 'Jordan', 'JP' => 'Japan',
       'KE' => 'Kenya', 'KG' => 'Kyrgyzstan', 'KH' => 'Cambodia', 'KN' => 'St. Kitts and Nevis',
       'KR' => 'Republic Of Korea', 'KW' => 'Kuwait', 'KY' => 'Cayman Islands',
-      'KZ' => 'Kazakstan', 'LA' => 'Lao People’s Democratic Republic', 'LB' => 'Lebanon',
+      'KZ' => 'Kazakstan', 'LA' => "Lao People's Democratic Republic", 'LB' => 'Lebanon',
       'LC' => 'St. Lucia', 'LK' => 'Sri Lanka', 'LR' => 'Liberia', 'LT' => 'Lithuania',
       'LU' => 'Luxembourg', 'LV' => 'Latvia', 'MD' => 'Republic Of Moldova', 'MG' => 'Madagascar',
       'MK' => 'Macedonia', 'ML' => 'Mali', 'MN' => 'Mongolia', 'MO' => 'Macau',

data/lib/app_store_info/version.rb

@@ -1,3 +1,3 @@
 module AppStoreInfo
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/app_store_info.rb

@@ -2,6 +2,7 @@ require 'app_store_info/version'
 require 'app_store_info/api'
 require 'app_store_info/app'
 require 'app_store_info/regions'
+require 'app_store_info/genres'
 
 module AppStoreInfo
   DEFAULT_REGION = 'us'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_store_info
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ricardo Otero