Class: AppStore::Emigrant::App

Inherits:
Object
  • Object
show all
Defined in:
lib/app-store-emigrant/app.rb

Overview

Represents a single iTunes mobile application

Defined Under Namespace

Classes: DoesNotExist, Invalid

Constant Summary collapse

VALID_EXTENSIONS =

List of valid extensions for an application

[
  '.ipa'
]
FILENAME_VERSION_REGEX =

Regular expression to match a version number in filenames

Regexp.new('([0-9.]+)(?:' + VALID_EXTENSIONS.join('|').gsub!('.', '\.') + ')')

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path) ⇒ App

Initializes application from given path



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/app-store-emigrant/app.rb', line 27

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

Instance Attribute Details

#clouddata ⇒ Object

Lazily queries Apple’s iTunes Store API for latest cloud data Note: Clouddata may be nil if the application was removed from the store



111
112
113
114
115
116
117
118
 
# File 'lib/app-store-emigrant/app.rb', line 111

def clouddata
  unless @clouddata
    response = Net::HTTP.get('itunes.apple.com', '/lookup?id=' + id.to_s)
    @clouddata = JSON.parse(response)['results'].first
  end
  
  @clouddata
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



23
24
25
 
# File 'lib/app-store-emigrant/app.rb', line 23

def path
  @path
end

Instance Method Details

#cloudversion ⇒ Object

Version available in the cloud



121
122
123
 
# File 'lib/app-store-emigrant/app.rb', line 121

def cloudversion
  clouddata && clouddata['version']
end

#filename ⇒ Object

Filename of this application (including extension)



46
47
48
49
50
51
52
 
# File 'lib/app-store-emigrant/app.rb', line 46

def filename
  unless @filename
    @filename = @path.basename.to_s
  end
  
  @filename
end

#id ⇒ Object

Unique application id



55
56
57
 
# File 'lib/app-store-emigrant/app.rb', line 55

def id
  metadata['itemId'] rescue nil
end

#metadata ⇒ Object

Lazily loads local metadata for this application from its iTunesMetadata.plist



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/app-store-emigrant/app.rb', line 87

def metadata
  unless @metadata
    
    # Determine plist name
    plist = Pathname.new(filename).basename('.ipa').to_s + '.plist'
    
    unless Cache.has?(plist)
      begin
        Zip::ZipFile.open(@path) do |zip|
          zip.extract('iTunesMetadata.plist', Cache.path_to(plist))
        end
      rescue Zip::ZipError => e
        raise Invalid, e.message
      end
    end
    
    @metadata = CFPropertyList.native_types(CFPropertyList::List.new(:file => Cache.path_to(plist)).value)
  end
  
  @metadata
end

#name ⇒ Object

Name of this application



60
61
62
 
# File 'lib/app-store-emigrant/app.rb', line 60

def name
  metadata['itemName'] rescue nil
end

#outdated? ⇒ Boolean

Whether this application is outdated

Returns:

  • (Boolean) 


126
127
128
 
# File 'lib/app-store-emigrant/app.rb', line 126

def outdated?
  return cloudversion && version != cloudversion
end

#valid? ⇒ Boolean

Whether this application is valid (validates metadata, id and name)

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/app-store-emigrant/app.rb', line 65

def valid?
  metadata && id && name rescue false
end

#version ⇒ Object

Version of this application



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/app-store-emigrant/app.rb', line 70

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