app-store-emigrant 0.0.7 → 0.0.8

data/CHANGELOG

@@ -1,5 +1,10 @@
 CHANGELOG
 
+v0.0.8
+- Refactored CLI to use Thor
+- Greatly improved usability for CLI
+- Metadata cache may now be cleared
+
 v0.0.7
 - Loosened strictness on runtime dependencies
 

data/README.md

@@ -14,14 +14,16 @@ For more information on the issues faced when moving countries with regards to A
 
 **TL;DR**: For reasons unknown to mankind, Apple has made it rather complicated to update applications bought in different stores, particularly after emigrating. iTunes mentions updates are available, but refuses to actually update these apps when asked to. These applications are also missing from the Purchases-tab.
 
-App Store Emigrant tries to soothe these pains - albeit only partially - by scanning your iTunes library folder for mobile applications and querying iTunes for the latest versions available. One can then manually go into the store and update each application, one by one. *sigh*
+App Store Emigrant tries to soothe these pains - albeit only partially - by scanning your iTunes library folder for mobile applications and querying iTunes for the latest versions available. One can then manually go into the store and update each application, one by one.
 
-![App Store Emigrant](http://office.moonsphere.net/app-store-emigrant.png)
+![App Store Emigrant](http://office.moonsphere.net/app-store-emigrant.png?v2)
 
 Installation
 ------------
 
-App Store Emigrant is available from RubyGems and can be installed through the command-line. Fire up your favourite terminal and run:
+App Store Emigrant is available from RubyGems and can be installed through the command-line.
+
+Fire up your favourite terminal and run:
 
     gem install app-store-emigrant
 
@@ -33,10 +35,16 @@ Installing on **OSX** and using the **default system Ruby**? Run:
 Usage
 -----
 
-Once installed, a new not-so-fantastically named binary called ```ase``` will be added to your path. Invoke the binary to start the verification process:
+Once installed, a new not-so-fantastically named binary called ```ase``` will be added to your path.
+
+Invoke its ```scan``` task to start the verification process:
+
+    ase scan
+
+If problems arise finding your default library, specify where your mobile applications lurk:
 
-    ase
+    ase scan ~/m00sic
 
-If App Store Emigrant complains that it cannot find your default library, help it along and specify where your mobile applications lurk:
+To clear the cache of application metadata, run the scan task with the ```-c``` or ```--clear-cache``` flag.
 
-    ase ~/m00sic
+    ase scan --clear-cache

data/app-store-emigrant.gemspec

@@ -12,20 +12,21 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/timkurvers/app-store-emigrant'
   s.summary     = 'App Store Emigrant will manually attempt to verify whether any of your local mobile applications are out of date'
   s.description = 'App Store Emigrant will manually attempt to verify whether any of your local mobile applications are out of date, which iTunes - unfortunately - will refuse once you have moved countries'
-  
+
   s.rubyforge_project = 'app-store-emigrant'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
-  
+
   s.add_dependency 'rubyzip',        '~> 0.9'
   s.add_dependency 'rainbow',        '~> 1.1'
   s.add_dependency 'CFPropertyList', '~> 2.0'
-  
+  s.add_dependency 'thor',           '~> 0.16.0'
+
   s.add_development_dependency 'rake'
-  
+
   if RUBY_VERSION < '1.9.2'
     s.add_dependency 'json'
     s.add_development_dependency 'minitest'

data/bin/ase

@@ -2,4 +2,4 @@
 
 require 'app-store-emigrant'
 
-AppStore::Emigrant::CLI.new ARGV
+AppStore::Emigrant::CLI.start

data/lib/app-store-emigrant/app.rb

@@ -8,89 +8,101 @@ require 'zip/zipfilesystem'
 module AppStore; end
 
 module AppStore::Emigrant
-  
+
   # Represents a single iTunes mobile application
   class App
-    
+
     # List of valid extensions for an application
     VALID_EXTENSIONS = [
       '.ipa'
     ]
-    
+
     # Regular expression to match a version number in filenames
     FILENAME_VERSION_REGEX = Regexp.new('([0-9.]+)(?:' + VALID_EXTENSIONS.join('|').gsub!('.', '\.') + ')')
-    
+
     attr_reader :path
     attr_writer :clouddata
-    
+
     # Initializes application from given path
     def initialize path
       @path = Pathname.new path
       @path = @path.expand_path unless @path.absolute?
-      
+
       # Ensure application exists
       unless @path.file?
         raise DoesNotExist, "Given path is not a valid application: #{@path}"
       end
-      
+
       # Ensure application has valid extension
       unless VALID_EXTENSIONS.include? @path.extname
         raise Invalid, "Given application does not have a valid extension: #{@path}"
       end
-      
+
       @metadata = nil
       @clouddata = nil
     end
-    
+
     # Filename of this application (including extension)
     def filename
       unless @filename
         @filename = @path.basename.to_s
       end
-      
+
       @filename
     end
-    
+
     # Unique application id
     def id
       metadata['itemId'] rescue nil
     end
-    
+
     # Name of this application
     def name
       metadata['itemName'] rescue nil
     end
-    
+
     # Whether this application is valid (validates metadata, id and name)
     def valid?
       metadata && id && name rescue false
     end
-    
+
     # Version of this application
     def version
       unless @version
-        
+
         # Extract version information (if available)
         @version = metadata['bundleShortVersionString'] || metadata['bundleVersion'] rescue nil
-        
+
         # Otherwise, use the filename
         unless @version
           @version = filename[FILENAME_VERSION_REGEX, 1]
         end
-        
+
       end
-      
+
       @version
     end
-    
+
+    # Property list name
+    def plist
+      Pathname.new(filename).basename('.ipa').to_s + '.plist'
+    end
+
+    # Whether this application's metadata is cached
+    def cached?
+      Cache.has? plist
+    end
+
+    # Forcefully caches this application's metadata
+    def cache!
+      metadata
+    end
+
     # Lazily loads local metadata for this application from its iTunesMetadata.plist
     def metadata
       unless @metadata
-        
-        # Determine plist name
-        plist = Pathname.new(filename).basename('.ipa').to_s + '.plist'
-        
-        unless Cache.has?(plist)
+
+        unless cached?
           begin
             Zip::ZipFile.open(@path) do |zip|
               zip.extract('iTunesMetadata.plist', Cache.path_to(plist))
@@ -99,13 +111,13 @@ module AppStore::Emigrant
             raise Invalid, e.message
           end
         end
-        
+
         @metadata = CFPropertyList.native_types(CFPropertyList::List.new(:file => Cache.path_to(plist)).value)
       end
-      
+
       @metadata
     end
-    
+
     # Lazily queries Apple's iTunes Store API for latest cloud data
     # Note: Clouddata may be nil if the application was removed from the store
     def clouddata
@@ -113,26 +125,26 @@ module AppStore::Emigrant
         response = Net::HTTP.get('itunes.apple.com', '/lookup?id=' + id.to_s)
         @clouddata = JSON.parse(response)['results'].first
       end
-      
+
       @clouddata
     end
-    
+
     # Version available in the cloud
     def cloudversion
       clouddata && clouddata['version']
     end
-    
+
     # Whether this application is outdated
     def outdated?
       return cloudversion && version != cloudversion
     end
-  
+
     # Raised when an application does not exist
     class DoesNotExist < StandardError; end
-  
+
     # Raised when an application is invalid (e.g non-valid extension)
     class Invalid < StandardError; end
-    
+
   end
-  
+
 end

data/lib/app-store-emigrant/cache.rb

@@ -3,33 +3,40 @@ require 'pathname'
 module AppStore; end
 
 module AppStore::Emigrant
-  
+
   # Cache mechanism
   class Cache
-    
-    PATH = begin
+
+    LOCATION = begin
       path = Pathname.new('~/.ase-cache').expand_path
       unless path.directory?
         path.mkpath
       end
       path
     end
-    
+
     # Whether cache has this item
     def self.has? item
-      PATH.join(item).file?
+      LOCATION.join(item).file?
     end
-    
+
     # Path to given item (whether existent or not)
     def self.path_to item
-      PATH.join(item).to_s
+      LOCATION.join(item).to_s
     end
-    
+
     # Forcefully clears the cache
     def self.clear!
-      # TODO: Implement clearing cache
+      LOCATION.children.each do |item|
+        item.delete if item.file?
+      end
+    end
+
+    # Number of items in the cache
+    def self.count
+      LOCATION.children.select { |item| item.file? }.length
     end
-    
+
   end
-  
+
 end

data/lib/app-store-emigrant/cli.rb

@@ -1,44 +1,89 @@
+# encoding: utf-8
+
 require 'rainbow'
+require 'thor'
 
 module AppStore; end
 
 module AppStore::Emigrant
-  
+
   # Represents the command line interface
-  class CLI
-    
-    # Initializes CLI instance with given arguments
-    def initialize args
-      
-      # Extract the path (if any)
-      path, = args
-      
+  class CLI < Thor
+
+    desc 'scan [LIBRARY PATH]', 'Scans an iTunes library and reports which of its mobile applications are out of date'
+    method_option :clear_cache, :type => :boolean, :default => false, :aliases => '-c', :desc => 'Clears application cache prior to scanning'
+    def scan path = nil
+
+      # Ensure all output is immediately flushed
+      $stdout.sync = true
+
       # Use the default library on this system when no path is specified
       library = path ? Library.new(path) : Library.default
-      
-      # Load cloud data in bulk
+
+      # Clear cache if requested
+      if options[:clear_cache]
+        Cache.clear!
+      end
+
+      # Verify cache integrity
+      puts 'Verifying cache integrity..'
+
+      # Forcefully cache metadata for each application that is not yet cached
+      library.apps.each do |app|
+
+        unless app.cached?
+          begin
+            app.cache!
+            puts " + #{app.name} v#{app.version}"
+          rescue App::Invalid => e
+            puts " ! Cannot cache #{app.filename}: #{e.message}".foreground(:red).bright
+          end
+        end
+
+      end
+
+      # Print cache statistics
+      puts "Done. Currently caching #{Cache.count} applications on your system."
+
+      puts
+
+      # Since all apps are cached, load cloud data in bulk
       library.clouddata!
-      
+
+      # Print library statistics
+      puts "Your library contains #{library.valid_apps.length} valid applications, of which #{library.outdated_apps.length} are outdated:"
+
       # Loop through all applications
       library.apps.each do |app|
-        
+
         if app.valid?
-          
-          # Print their name, version and whether it's outdated
-          print app.name + ' @ ' + "v#{app.version}".foreground(app.outdated? ? :red : :green)
+
+          # Generate color-coded version
+          version = "v#{app.version}".foreground(app.outdated? ? :red : :green)
+          if app.outdated?
+            version = version.bright
+          end
+
+          # Print application name, version and whether it's outdated
+          print " · #{app.name} #{version}"
           if app.outdated?
-            print " (v#{app.cloudversion} available in the cloud)" 
+            print " · v#{app.cloudversion} available".foreground(:white)
           end
+
+          puts
         else
-          print app.filename + ' is invalid (metadata, id or name missing)'
+          puts " ! #{app.filename} is invalid (metadata, id or name missing)".foreground(:red).bright
         end
-        
-        puts
-        
+
       end
-      
+
     end
-    
+
+    desc 'version', 'Prints version information'
+    def version
+      puts "App Store Emigrant v#{AppStore::Emigrant::VERSION}"
+    end
+
   end
-  
+
 end

data/lib/app-store-emigrant/library.rb

@@ -5,34 +5,44 @@ require 'pathname'
 module AppStore; end
 
 module AppStore::Emigrant
-  
+
   # Represents a single iTunes mobile applications library
   class Library
-    
+
     attr_reader :path
-    
+
     # Initializes library from given path
     def initialize path
       @path = Pathname.new path
       @path = @path.expand_path unless @path.absolute?
-      
+
       # Ensure library is a valid directory
       unless @path.directory?
         raise DoesNotExist, "Given path is not a valid mobile applications library: #{@path}"
       end
-      
+
       @apps = nil
     end
-    
+
     # Retrieves a list of applications
     def apps
       unless @apps
         load!
       end
-      
+
       @apps
     end
-    
+
+    # Retrieves a list of valid applications
+    def valid_apps
+      apps.select { |app| app.valid? }
+    end
+
+    # Retrieves a list of outdated applications
+    def outdated_apps
+      apps.select { |app| app.valid? && app.outdated? }
+    end
+
     # Forcefully loads applications from disk
     def load!
       @apps = []
@@ -45,15 +55,15 @@ module AppStore::Emigrant
       end
       self
     end
-    
+
     # Populates applications' cloud data in bulk
     def clouddata!
-      
+
       # Collect all application ids, skipping any invalid ones
       ids = apps.collect do |app|
         app.id
       end.compact
-      
+
       # Queries Apple's iTunes Store API for latest cloud data using undocumented bulk method
       response = Net::HTTP.get('itunes.apple.com', '/lookup?id=' + ids.join(','))
       results = JSON.parse(response)['results']
@@ -63,66 +73,66 @@ module AppStore::Emigrant
         end
       end
     end
-    
+
     # Searches for application with given id
     def get id
       apps.select do |app|
         app.id == id
       end.first
     end
-    
+
     # Searches for applications containing given snippet in filename
     def find snippet
       apps.select do |app|
         app.filename.include? snippet
       end
     end
-    
+
     # Returns the default library (if any) for this system
     # See Apple's support documents as to where libraries can be found
     # - http://support.apple.com/kb/ht1391
     # - http://support.apple.com/kb/ht3847
     def self.default
-      
+
       # Use the homedir provided through the environment
       homedir = ENV['HOME']
-      
+
       # List all locations
       locations = [
-        
+
         # Mac OSX and Windows Vista
         "#{homedir}/Music/iTunes/iTunes Media/Mobile Applications",
-        
+
         # Windows 7
         "#{homedir}/My Music/iTunes/iTunes Media/Mobile Applications",
-        
+
         # Windows XP
         "#{homedir}/My Documents/My Music/iTunes/iTunes Media/Mobile Applications",
-        
+
         # Mac OSX and Windows Vista (prior to iTunes 9)
         "#{homedir}/Music/iTunes/Mobile Applications",
-        
+
         # Windows 7 (prior to iTunes 9)
         "#{homedir}/My Music/iTunes/Mobile Applications",
-        
+
         # Windows XP (prior to iTunes 9)
         "#{homedir}/My Documents/My Music/iTunes/Mobile Applications",
-        
+
       ]
-      
+
       # Raise exception if no default library could be found
       path = Dir.glob(locations).first
       unless path
         raise DoesNotExist, 'Could not locate default iTunes mobile applications library'
       end
-      
+
       # Return an instance of this default library
       Library.new path
     end
-    
+
     # Raised when a library does not exist
     class DoesNotExist < StandardError; end
-    
+
   end
-  
+
 end

data/lib/app-store-emigrant/version.rb

@@ -2,7 +2,7 @@
 module AppStore; end
 
 module AppStore::Emigrant
-  
-  VERSION = '0.0.7'
+
+  VERSION = '0.0.8'
 
 end

data/specs/app.rb

@@ -6,56 +6,56 @@ require 'minitest/autorun'
 include AppStore::Emigrant
 
 describe App do
-  
+
   LIBRARY = ROOT + '/fixtures/dummy-library'
-  
+
   before do
     @dummy = App.new(LIBRARY + '/Dummy.ipa')
     @gta = App.new(LIBRARY + '/GTA.ipa')
     @soosiz = App.new(LIBRARY + '/Soosiz.ipa')
   end
-  
+
   it 'must be a valid file on disk' do
     lambda do
       App.new(LIBRARY + '/Non-Existent.ipa')
     end.must_raise App::DoesNotExist
   end
-  
+
   it 'must have a valid extension' do
     lambda do
       App.new(LIBRARY + '/Non-Existent.ipa')
     end.must_raise App::DoesNotExist
   end
-  
+
   it 'can determine its own filename' do
     @gta.filename.must_equal 'GTA.ipa'
     @soosiz.filename.must_equal 'Soosiz.ipa'
   end
-  
+
   it 'will report invalid structures' do
     @dummy.valid?.must_equal false
     @dummy.id.must_equal nil
     @dummy.version.must_equal nil
   end
-  
+
   it 'can extract its name' do
     @gta.name.must_equal 'Grand Theft Auto: Chinatown Wars'
     @soosiz.name.must_equal 'Soosiz'
   end
-  
+
   it 'can query local metadata' do
     @gta.version.must_equal '0.9'
     @soosiz.version.must_equal '1.1'
   end
-  
+
   it 'can load cloud data' do
     @gta.cloudversion.must_equal '1.1.0'
     @soosiz.cloudversion.must_equal '1.3'
   end
-  
+
   it 'can determine whether it is outdated' do
     @gta.outdated?.must_equal true
     @soosiz.outdated?.must_equal true
   end
-  
+
 end

data/specs/library.rb

@@ -6,46 +6,48 @@ require 'minitest/autorun'
 include AppStore::Emigrant
 
 describe Library do
-  
+
   before do
     @library = Library.new(ROOT + '/fixtures/dummy-library')
   end
-  
+
   it 'must be located in a valid directory' do
     @library.must_be_instance_of Library
-    
+
     lambda do
       Library.new(ROOT + '/non-existent-library')
     end.must_raise Library::DoesNotExist
   end
-  
+
   it 'will gracefully and lazily load applications' do
     @library.instance_variable_get('@apps').must_be_nil
     @library.apps.must_be_instance_of Array
     @library.apps.length.must_equal 3
+    @library.valid_apps.must_be_instance_of Array
+    @library.valid_apps.length.must_equal 2
   end
-  
+
   it 'can find applications by (partial) filename' do
     @library.find('Dummy').length.must_equal 1
     @library.find('GTA').length.must_equal 1
     @library.find('Soosiz').length.must_equal 1
   end
-  
+
   it 'can get applications by id' do
     @library.get(344186162).filename.must_equal 'GTA.ipa'
     @library.get(331891505).filename.must_equal 'Soosiz.ipa'
   end
-  
+
   it 'can load cloud data in bulk' do
     gta = @library.find('GTA').first
     soosiz = @library.find('Soosiz').first
     gta.instance_variable_get('@clouddata').must_be_nil
     soosiz.instance_variable_get('@clouddata').must_be_nil
-    
+
     @library.clouddata!
-    
+
     gta.instance_variable_get('@clouddata').must_be_instance_of Hash
     soosiz.instance_variable_get('@clouddata').must_be_instance_of Hash
   end
-  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app-store-emigrant
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-31 00:00:00.000000000 Z
+date: 2012-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70275229291660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *70275229291660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rainbow
-  requirement: &70275229291160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70275229291160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
-  requirement: &70275229290700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,31 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70275229290700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70275229290320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +85,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275229290320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: App Store Emigrant will manually attempt to verify whether any of your
   local mobile applications are out of date, which iTunes - unfortunately - will refuse
   once you have moved countries
@@ -101,21 +137,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -972531457948704449
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -972531457948704449
 requirements: []
 rubyforge_project: app-store-emigrant
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: App Store Emigrant will manually attempt to verify whether any of your local