itunes_crawler 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: "bundle exec rspec spec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,9 @@
+if RUBY_VERSION =~ /1.9/
+  Encoding.default_external = Encoding::UTF_8
+  Encoding.default_internal = Encoding::UTF_8
+end
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in itunes_crawler.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Barnabás Birmacher
+
+MIT License
+
+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,69 @@
+## ITunesCrawler
+[![Build Status](https://travis-ci.org/birmacher/iTunesCrawler.png)](https://travis-ci.org/birmacher/iTunesCrawler)
+[![Code Climate](https://codeclimate.com/github/birmacher/iTunesCrawler.png)](https://codeclimate.com/github/birmacher/iTunesCrawler)
+
+ITunesCrawler provides an easy way to download the requested iTunes data through Apple's Search API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'itunes_crawler'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install itunes_crawler
+```
+
+## Usage
+
+### Download iTunes info for a single app
+
+```ruby
+storefrontFetcher = ITunesCrawler::StorefrontFetcher.new
+storefrontFetcher.on_success { |itunes_item| p itunes_item["trackName"] }
+storefrontFetcher.on_fail { |app_id| p "Nooooooo" }
+storefrontFetcher.fetch( '557137623', 'us' )
+```
+
+### Download iTunes info for multiple apps
+
+```ruby
+storefrontFetcher = ITunesCrawler::StorefrontFetcher.new
+storefrontFetcher.on_success { |itunes_item| p itunes_item["trackName"] }
+storefrontFetcher.on_fail { |app_id| p "Nooooooo" }
+storefrontFetcher.fetch( ['557137623', '284882215'], 'us' )
+```
+
+### Change retry count of failed requests
+
+```ruby
+storefrontFetcher = ITunesCrawler::StorefrontFetcher.new( 1 )
+```
+
+or 
+
+```ruby
+storefrontFetcher = ITunesCrawler::StorefrontFetcher.new
+storefrontFetcher.retry_count = 1
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+MIT license

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/itunes_crawler.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'itunes_crawler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "itunes_crawler"
+  spec.version       = ITunesCrawler::VERSION
+  spec.authors       = ["Barnabas Birmacher"]
+  spec.email         = ["birmacher@gmail.com"]
+  spec.description   = "ITunesCrawler provides an easy way to download the requested iTunes data through Apple's Search API."
+  spec.summary       = "ITunesCrawler provides an easy way to download the requested iTunes data through Apple's Search API."
+  spec.homepage      = "https://github.com/birmacher/iTunesCrawler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "typhoeus", "~> 0.6.2"
+  spec.add_dependency "json", "~> 1.7.7"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/itunes_crawler.rb

@@ -0,0 +1,5 @@
+require "itunes_crawler/version"
+require "itunes_crawler/storefront_fetcher"
+
+module ITunesCrawler
+end

data/lib/itunes_crawler/storefront_fetcher.rb

@@ -0,0 +1,20 @@
+require "typhoeus"
+require "itunes_crawler/storefront_fetcher/callback"
+require "itunes_crawler/storefront_fetcher/fetcher"
+
+module ITunesCrawler
+
+  class StorefrontFetcher
+    include StorefrontFetcher::Callback
+    include StorefrontFetcher::Fetcher
+  
+    attr_accessor :retry_count
+  
+    def initialize( retry_count=5 )
+      @retry_count = retry_count
+      @hydra = Typhoeus::Hydra.new
+    end
+    
+  end
+  
+end

data/lib/itunes_crawler/storefront_fetcher/callback.rb

@@ -0,0 +1,18 @@
+module ITunesCrawler
+  class StorefrontFetcher
+
+    module Callback
+      # Completetion block
+      def on_success(&block)
+        @success_block = block if block_given?
+        @success_block
+      end
+      
+      def on_fail(&block)
+        @fail_block = block if block_given?
+        @fail_block
+      end
+    end
+    
+  end
+end

data/lib/itunes_crawler/storefront_fetcher/fetcher.rb

@@ -0,0 +1,81 @@
+require "json"
+require "cgi"
+require "itunes_crawler/storefront_fetcher/retryable"
+
+module ITunesCrawler
+  class StorefrontFetcher
+
+    module Fetcher
+      include StorefrontFetcher::Retryable
+      
+      # Download iTunes item data
+      def fetch(itunes_ids, country_code)
+        # Save iTunes IDs to an array
+        ( ( queue ||= [] ) << itunes_ids ).flatten!
+
+        # Slice the array to multiple arrays with size of 200
+        chunks = queue.each_slice( 200 ).to_a
+        chunks.each do |chunk|
+          add_url_to_queue "https://itunes.apple.com/lookup?id=#{chunk.join(",")}&country=#{country_code}", false
+        end
+        @hydra.run
+      end
+      
+      private
+      
+      def add_url_to_queue(url, start=true)
+        request = Typhoeus::Request.new( url, :followlocation => true )
+        
+        # Callbacks
+        request.on_success do |response|
+          return unless @success_block
+          
+          # Save response
+          json_response = JSON.parse(response.body)
+          itunes_data = json_response["results"]
+          
+          # Also a failed request if there is no itunes_data
+          if !itunes_data ||
+             itunes_data.empty?
+             
+            get_failed_itunes_ids( response.request.base_url )
+          else
+            # Parse downloaded data
+            itunes_data.each do |itunes_item|
+              @success_block.call itunes_item
+            end
+          end
+        end
+        
+        request.on_failure do |response|
+          failed_url = response.request.base_url
+          
+          if retryable?( failed_url )
+            add_url_to_queue( failed_url )
+          else
+            get_failed_itunes_ids( failed_url )          
+          end
+        end
+   
+        # Add to queue and start if requested
+        @hydra.queue request
+        @hydra.run if start
+      end
+    end
+    
+    private
+    
+    def get_failed_itunes_ids_from_url(url)
+       CGI.parse(URI(url).query)["id"].first.split( "," )
+    end
+    
+    def get_failed_itunes_ids( url )
+      return unless @fail_block
+      
+      get_failed_itunes_ids_from_url( url ).each do |itunes_id|
+        @fail_block.call( itunes_id )
+      end
+    end
+    
+  end
+end

data/lib/itunes_crawler/storefront_fetcher/retryable.rb

@@ -0,0 +1,29 @@
+module ITunesCrawler
+  class StorefrontFetcher
+
+    module Retryable
+      def retryable?(url)
+        return false if @retry_count <= 0
+      
+        @failed_urls ||= {}
+        
+        # It's our first try
+        # save the url and that's all for now
+        unless @failed_urls[url]
+          @failed_urls[url] = 1
+          true
+        else
+          # No more try for you
+          retries = @failed_urls[url]
+          if retries + 1 >= @retry_count
+            false
+          else
+            @failed_urls[url] = retries + 1
+            true
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/itunes_crawler/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'itunes_crawler'
+
+RSpec.configure do |config|
+
+end

data/spec/storefront_fetcher_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe ITunesCrawler::StorefrontFetcher do
+  describe "it should download data from iTunes for" do
+    it "one iTunes id" do
+      storefrontFetcher = ITunesCrawler::StorefrontFetcher.new
+      storefrontFetcher.on_success do |itunes_item|
+        itunes_item.should be_a_kind_of( Hash )
+      end
+      storefrontFetcher.on_fail { |itunes_id| fail }
+      storefrontFetcher.fetch( '557137623', 'us' )
+    end
+    
+    it "multiple itunes ids" do
+      storefrontFetcher = ITunesCrawler::StorefrontFetcher.new
+      storefrontFetcher.on_success do |itunes_item|
+        itunes_item.should be_a_kind_of( Hash )
+      end
+      storefrontFetcher.on_fail { |itunes_id| fail }
+      storefrontFetcher.fetch( ['557137623', '284882215'], 'us' )
+    end
+  end
+  
+  describe "response should include readable values" do
+    it do
+      storefrontFetcher = ITunesCrawler::StorefrontFetcher.new
+      storefrontFetcher.on_success do |itunes_item|
+        itunes_item["kind"].should eql "software"
+      end
+      storefrontFetcher.on_fail { |itunes_id| fail }
+      storefrontFetcher.fetch( '557137623', 'us' )
+    end
+  end
+  
+  describe "it should fail while trying to download data for invalid iTunes ID" do
+    it do
+      storefrontFetcher = ITunesCrawler::StorefrontFetcher.new
+      storefrontFetcher.on_success { |itunes_id| fail }
+      storefrontFetcher.on_fail do |itunes_id|
+        itunes_id.should eql "nope"
+      end
+      storefrontFetcher.fetch( "nope", 'us' )
+    end
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: itunes_crawler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Barnabas Birmacher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ITunesCrawler provides an easy way to download the requested iTunes data
+  through Apple's Search API.
+email:
+- birmacher@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- itunes_crawler.gemspec
+- lib/itunes_crawler.rb
+- lib/itunes_crawler/storefront_fetcher.rb
+- lib/itunes_crawler/storefront_fetcher/callback.rb
+- lib/itunes_crawler/storefront_fetcher/fetcher.rb
+- lib/itunes_crawler/storefront_fetcher/retryable.rb
+- lib/itunes_crawler/version.rb
+- spec/spec_helper.rb
+- spec/storefront_fetcher_spec.rb
+homepage: https://github.com/birmacher/iTunesCrawler
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ITunesCrawler provides an easy way to download the requested iTunes data
+  through Apple's Search API.
+test_files:
+- spec/spec_helper.rb
+- spec/storefront_fetcher_spec.rb
+has_rdoc: