appscreens 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03411f3d67faa484d3c00dbf1d1f12327a5d1f85
+  data.tar.gz: df820c55dd24fb203bf6590cab1091f3e7a63232
+SHA512:
+  metadata.gz: a0d52ab615866fb4106dc94be0c6bf102b5ff2ac392af4d57929f5ce3cab242fcf79b37079144c532e1baa926db72c286cab268fd58c6cf833a1d8b8aaf23557
+  data.tar.gz: 1dacfbc30a19a1d418979a7ec1014406f712f37fdbbee5f23677fe8098d4f3817a56133991935fe508a652dbe0d0ced066039ffe9e8cc770b9dfb80f3da6727a

data/.gitignore

@@ -0,0 +1,23 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dan Williams
+
+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,19 @@
+# AppScreens
+
+A command-line interface for querying the App Store and downloading app screenshots, and optionally, app icons.
+
+## Installation
+
+Run
+
+    $ gem install appscreens
+
+## Usage
+
+    $ appscreens grab 333903271 --icon
+
+to download Twitter's app screenshots and app icon to a folder named `twitter_screens`.
+
+## Todo
+
+* Add `--ipad` option to download the iPad screenshots.

data/Rakefile

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

data/appscreens.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'appscreens/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "appscreens"
+  spec.version       = Appscreens::VERSION
+  spec.authors       = ["Dan Williams"]
+  spec.email         = ["dan@danwilliams.co"]
+  spec.summary       = %q{A command-line interface for querying the App Store and downloading app screenshots.}
+  spec.homepage      = "http://github.com/danwilliams64/appscreens"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'colored' # coloured terminal output
+  spec.add_dependency 'commander' # CLI parser
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/bin/appscreens

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'appscreens'
+
+require 'commander/import'
+require 'fileutils'
+
+HighLine.track_eof = false # Fix for built-in Ruby
+Signal.trap("INT") {} # Suppress backtrace when exiting command
+
+program :name, "appscreens"
+program :version, Appscreens::VERSION
+program :description, 'A command-line interface for querying the App Store and downloading app screenshots'
+
+program :help, 'Author', 'Dan Williams <dan@danwilliams.co>'
+program :help, 'Website', 'https://github.com/danwilliams64'
+program :help_formatter, :compact
+
+default_command :grab
+
+command :grab do |c|
+  c.syntax = 'appscreens grab APP_ID'
+  c.summary = 'Downloads the app\'s screenshots and optionally icon into a new directory named after the app.'
+  c.description = 'Appscreens makes it easy to download an app\'s screenshots and icon for editorial use on blogs. '
+  c.option '--icon', 'Download the app\'s high resolution artwork in addition to the screen shots.'
+
+  c.example 'grab', 'appscreens grab 886427730'
+
+  c.action do |args, options|
+    say_error "Missing app ID" and abort unless app_id = args.first
+
+    begin
+      result = client.lookup(app_id)
+      if result.empty?
+        say_error "Can't find app with id: #{app_id}" and abort
+      end
+
+      dir = FileUtils::mkdir_p("#{result["trackName"].downcase.tr(" ","_")}_screens").first
+      client.download_screenshots(app: result, icon: options.icon, destination: dir)
+
+    end
+
+  end
+end
+
+private
+
+def client
+  @client ||= Appscreens::Client.new
+end

data/lib/appscreens/client.rb

@@ -0,0 +1,54 @@
+require 'json'
+require 'net/http'
+require 'open-uri'
+
+module Appscreens
+  ITUNES_SEARCH_ENDPOINT = "https://itunes.apple.com/"
+  ITUNES_SEARCH_RESULTS_KEY = "results"
+  APP_SCREENSHOTS_KEY = "screenshotUrls"
+  APP_NAME_KEY = "trackName"
+  APP_ICON_KEY = "artworkUrl100"
+
+  class Client
+    def initialize
+      @search_url = ITUNES_SEARCH_ENDPOINT
+      @country = 'US'
+    end
+
+    def lookup(app_id)
+      uri = URI.join(@search_url, "lookup")
+      uri.query = URI.encode_www_form( {id: app_id} )
+
+      json_response_from_uri(uri)[ITUNES_SEARCH_RESULTS_KEY].first
+    end
+
+    def download_screenshots(app:, icon:, destination:)
+      screenshots = app[APP_SCREENSHOTS_KEY]
+      app_name = app[APP_NAME_KEY].downcase.tr(" ","_")
+
+      screenshots.each_with_index do |screen_url, index|
+        puts "Downloading screenshot #{index + 1} of #{screenshots.length}..."
+        file_name = "#{destination}/#{app_name}_#{index + 1}.jpeg"
+        File.open(file_name, 'wb') { |fp| fp.write(open(screen_url).read) }
+      end
+
+      if icon
+        puts "Downloading app icon..."
+        File.open("#{destination}/#{app_name}_icon.png", 'wb') { |fp| fp.write(open(app[APP_ICON_KEY]).read) }
+      end
+
+      puts '#######################################################################'.green
+      puts "Finished grabbing artwork for #{app[APP_NAME_KEY]}".green
+      puts '#######################################################################'.green
+
+    end
+
+    private
+
+    def json_response_from_uri(uri)
+      response = Net::HTTP.get_response(uri)
+      JSON.parse(response.body) rescue nil
+    end
+
+  end
+end

data/lib/appscreens/version.rb

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

data/lib/appscreens.rb

@@ -0,0 +1,5 @@
+require 'appscreens/version'
+require 'appscreens/client'
+
+# Third party code
+require 'colored'

data/spec/client_spec.rb

@@ -0,0 +1,39 @@
+require 'minitest/unit'
+require 'appscreens'
+
+class ClientTest < Minitest::Test
+
+  def setup
+    @client = Appscreens::Client.new
+    @app_id = "333903271"
+  end
+
+  def teardown
+    system("rm -rf /tmp/appscreens")
+  end
+
+  def test_can_lookup_a_given_app_id
+    app = @client.lookup @app_id
+    assert_instance_of(Hash, app, "App should be instance of Hash")
+  end
+
+  def test_app_should_have_screenshots_key
+    app = @client.lookup @app_id
+    screenshots = app[Appscreens::APP_SCREENSHOTS_KEY]
+    assert(screenshots.length > 0, "Screenshots array should contain screenshots")
+  end
+
+  def test_download_screenshots_to_filesystem
+    system("rm -rf /tmp/appscreens")
+
+    path = "/tmp/appscreens"
+    FileUtils::mkdir_p(path)
+    app = @client.lookup @app_id
+    @client.download_screenshots(app: app, icon: true, destination: path)
+
+    expected_file_count = app[Appscreens::APP_SCREENSHOTS_KEY].length + 1
+    file_count = Dir.glob(File.join(path, '**', '*')).select { |file| File.file?(file) }.count
+    assert_equal(expected_file_count, file_count, "Expected #{expected_file_count} files. There was #{file_count}")
+  end
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: appscreens
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored
+  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: commander
+  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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dan@danwilliams.co
+executables:
+- appscreens
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appscreens.gemspec
+- bin/appscreens
+- lib/appscreens.rb
+- lib/appscreens/client.rb
+- lib/appscreens/version.rb
+- spec/client_spec.rb
+homepage: http://github.com/danwilliams64/appscreens
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A command-line interface for querying the App Store and downloading app screenshots.
+test_files:
+- spec/client_spec.rb
+has_rdoc: