applebot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8abd1f581c359df890dca0e9ed9a458d6244a41d
+  data.tar.gz: 1af37a02a80c482bc8da15de976853215d4f203b
+SHA512:
+  metadata.gz: e5eb30d8e6205b5d25347ea4c16953d6540ba276fa92ccab84ea659d019f2dfd3386c7cf06fddb461b98a2f5dac4c4bcbf3a1b2b6e7a12d5c837433135d3b41b
+  data.tar.gz: 8078823f751ddf30c2ffc578fd3273c151c9e01a735e8f1f719ada1dd7117e4ba0808436475dd3fc7721e58752fc62e6e41a047f8247bec527a6155f8437a9c1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    applebot (0.0.1)
+      activesupport (>= 3.2)
+      commander (~> 4.1.2)
+      terminal-table (>= 1.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.3)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    commander (4.1.6)
+      highline (~> 1.6.11)
+    dotenv (0.10.0)
+    highline (1.6.21)
+    i18n (0.6.9)
+    minitest (4.7.5)
+    multi_json (1.9.3)
+    rake (10.1.0)
+    terminal-table (1.4.5)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  applebot!
+  dotenv
+  rake

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013-2014 Turboprop Inc (https://usepropeller.com/)
+
+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,153 @@
+# AppleBot - The Apple Robot
+
+A CLI and Ruby library to manage Apple Developer Center and iTunes Connect tasks. Uses [CasperJS](http://casperjs.org/) for easy maintenance and flexibility.
+
+## Requirements
+
+AppleBot requires [CasperJS](http://casperjs.org/), which can be installed using [Homebrew](http://brew.sh/):
+
+```
+$ brew install casperjs --devel
+```
+
+## Installation
+
+```
+$ gem install applebot
+```
+
+## Usage
+
+### Commands
+
+These commands run using iTunes Connect:
+
+- `app:create` - Creates an entry for a new app on iTunes Connect
+- `app:update` - Creates an entry for a new update to an existing app on iTunes Connect
+- `app:reject_binary` - Rejects the binary for a pending release (either new or an update)
+- `app:remove_from_sale` - Removes the app from sale in all territories
+
+These commands run using the Apple Developer Center:
+
+- `app_id:create` - Creates a bundle identifier
+- `app_id:delete` - Removes a bundle identifier
+- `profile:create` - Creates a provisioning profile
+- `profile:download` - Downloads an existing provisioning profile
+- `profile:list` - Lists all provisioning profiles
+
+These commands can run on either iTunes Connect or Apple Developer Center:
+
+- `app_id:list` - Lists all bundle identifiers
+
+#### JSON Manifests
+
+Most commands take in options - you can either pass them individually, or use a JSON manifest file like this:
+
+```json
+{
+    "name": "My new app",
+    "app_id": "com.usepropeller.mynewapp"
+}
+```
+
+For example, the following commands are equivalent usng this JSON manifest:
+
+```shell
+$ applebot app_id:create --name 'My new app' --app_id 'com.usepropeller.mynewapp'
+$ applebot app_id:create --manifest ./manifest.json
+```
+
+```ruby
+> AppleBot.app_id.create(name: 'My new app', app_id: 'com.usepropeller.mynewapp')
+> AppleBot.app_id.create(manifest './manifest.json')
+```
+
+### CLI
+
+AppleBot installs an `applebot` command, which you can explore with `-h` flags:
+
+```shell
+$ applebot -h
+
+  Commands:
+    app:create           Create App
+    app:reject_binary    Reject the binary of an pending release
+    app:remove_from_sale Remove app from sale
+    app:update           Update App
+    app_id:create        Create App ID
+    app_id:delete        Delete App ID
+    app_id:list          List App IDs
+    help                 Display global or [command] help documentation.
+    profile:create       Create Provisioning Profile
+    profile:download     Download a Provisioning Profile
+    profile:list         List Provisioning Profiles
+
+  Global Options:
+    --manifest FILE.json Use a JSON file to load options for each command
+    --username USERNAME  Username to login to Apple Service, or $APPLEBOT_USERNAME
+    --password PASSWORD  Password to login to Apple Service, or $APPLEBOT_PASSWORD
+    --format FORMAT      Output format - ['json', 'pretty']
+    --verbose            Verbose output
+```
+
+#### Authentication
+
+For every command, you can pass `--username` and `--password` flags to enter you auth credentials; you can also set `APPLEBOT_USERNAME` and `APPLEBOT_PASSWORD` environment variables.
+
+### Ruby
+
+The Ruby library uses an `AppleBot` module, and its methods map to the CLI commands:
+
+```ruby
+> require 'applebot'
+=> true
+> AppleBot.app.create(options: here)
+```
+
+#### Authentication
+
+The Ruby library has a few shortcuts for logging in to Apple services:
+
+```ruby
+# pass as options
+AppleBot.app.create(username: "username", password: "password")
+
+# run in block
+AppleBot.with_credentials(username: "username", password: "password") do
+    AppleBot.app.create(options)
+end
+
+# set globally
+AppleBot.set_credentials(username: "username", password: "password")
+```
+
+
+### Output
+
+The `:list` commands are meant to return some data. If you're using the Ruby library, you'll receive an `Array` when the command is done; if you're using the CLI, the last line will output a JSON object with one entry.
+
+```ruby
+AppleBot.app_ids.all
+=> ["com.usepropeller.myapp"]
+```
+
+```bash
+$ applebot app_ids:all
+{"app_ids": ["com.usepropeller.myapp"]}
+```
+
+If you're using any other command (which generally create side-effects), the end result will be `true` in Ruby, or exit code 0 on the CLI.
+
+#### Verbose & Pretty Output
+
+You can base a `--verbose` flag (or a `verbose: true` option in Ruby) to see all of the output as each script processes. There are two output formats, `json` and `pretty`, which you are set with either the `--format` flag or `format: 'format_string'` in Ruby.
+
+## Contact
+
+[Clay Allsopp](http://clayallsopp.com/)
+- [clay@usepropeller.com](mailto:clay@usepropeller.com)
+- [@clayallsopp](https://twitter.com/clayallsopp)
+
+## License
+
+AppleBot is available under the MIT license. See the [LICENSE](LICENSE) file for more info.

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "bundler/setup"
+
+require './lib/applebot.rb'
+
+require 'dotenv'
+Dotenv.load
+
+task :console do
+  require 'irb'
+  ARGV.clear
+  IRB.start
+end

data/applebot.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "applebot/version"
+
+Gem::Specification.new do |s|
+  s.name        = "applebot"
+  s.license     = "MIT"
+  s.authors     = ["Clay Allsopp"]
+  s.email       = "clay@usepropeller.com"
+  s.homepage    = AppleBot::WEBSITE
+  s.version     = AppleBot::VERSION
+  s.summary     = "AppleBot"
+  s.description = AppleBot::DESCRIPTION
+
+  s.add_dependency "commander", "~> 4.1.2"
+  s.add_dependency "activesupport", ">= 3.2"
+  s.add_dependency "terminal-table", ">= 1.4.0"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "dotenv"
+
+  s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }
+  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"]
+end

data/bin/applebot

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+require 'commander/import'
+
+applebot = File.join(File.dirname(__FILE__), '..', 'lib', 'applebot')
+require applebot
+
+HighLine.track_eof = false # Fix for built-in Ruby
+Signal.trap("INT") {} # Suppress backtrace when exiting command
+
+program :name, 'AppleBot'
+program :version, AppleBot::VERSION
+program :description, AppleBot::DESCRIPTION
+
+program :help, 'Author', 'Clay Allsopp <clay@usepropeller.com>'
+program :help, 'Website', AppleBot::WEBSITE
+program :help_formatter, :compact
+
+default_command :help
+
+global_option('--manifest FILE.json', 'Use a JSON file to load options for each command') { |file|
+  $manifest_file = file
+}
+
+global_option('--username USERNAME', 'Username to login to Apple Service, or $APPLEBOT_USERNAME') { |username|
+  $username = username
+}
+
+global_option('--password PASSWORD', 'Password to login to Apple Service, or $APPLEBOT_PASSWORD') { |password|
+  $password = password
+}
+
+global_option('--format FORMAT', "Output format - 'json' or 'pretty'") { |format|
+  $format = format
+}
+
+global_option('--verbose', "Verbose output") {|verbose|
+  $verbose = verbose
+}
+
+AppleBot.commands.each do |apple_command|
+  command apple_command.cli_command.to_sym do |c|
+    c.syntax = "applebot #{apple_command.cli_command} [options]"
+    c.description = apple_command.description
+    c.summary = apple_command.description
+
+    (apple_command.options.required + apple_command.options.optional).each do |apple_option|
+      c.option "--#{apple_option.key} VALUE", apple_option.cli_description
+    end
+
+    c.action do |args, options|
+      user_options = {
+        manifest: $manifest_file,
+        format: $format || 'pretty',
+        verbose: $verbose,
+        print_result: true
+      }.merge(options.__hash__)
+
+      credentials = {username: $username, password: $password}
+
+      ret_value = false
+      AppleBot.with_credentials(credentials) do |ab|
+        ret_value = ab.run_command(apple_command.ruby_method, user_options)
+      end
+      $username = nil
+      $password = nil
+      $manifest_file = nil
+      $format = nil
+      $verbose = nil
+      ret_value
+    end
+  end
+end

data/create_app_id_manifest.js

@@ -0,0 +1,6 @@
+{
+    "name": "Test App 9007",
+    "username": "clay+applestore@usepropeller.com",
+    "password": "B0nnyB3ar",
+    "app_id": "com.usepropeller.test.test9007"
+}

data/create_manifest.js

@@ -0,0 +1,24 @@
+{
+    "username": "clay+applestore@usepropeller.com",
+    "password": "B0nnyB3ar",
+    "title": "Test App 9007",
+    "sku": "TEST_APP_9007",
+    "id": "com.usepropeller.test.test9007",
+    "price_tier": "free",
+    "app_version": "1.0.0",
+    "keywords": "this,thing,cool",
+    "support_url": "http://usepropeller.com",
+    "description": "My cool app",
+    "simulated_gambling": "none",
+    "horror_fear_themes": "none",
+    "primary_category": "book",
+    "secondary_category": "catalogs",
+    "first_name": "Clay",
+    "last_name": "Allsopp",
+    "email": "Clay.allsopp@gmail.com",
+    "phone": "9197937595",
+    "copyright": "Thing 2013",
+    "large_icon": "/Users/clayallsopp/Desktop/itunes_1.jpg",
+    "screenshots_35": "[\"/Users/clayallsopp/Projects/Apptory/iOS/profiles/apps/705/screenshots/products_35.png\"]",
+    "screenshots_4": "[\"/Users/clayallsopp/Projects/Apptory/iOS/profiles/apps/705/screenshots/products_4.png\"]"
+}

data/lib/applebot/command_proxy.rb

@@ -0,0 +1,44 @@
+module AppleBot
+  class CommandProxy
+    class_attribute :proxies
+    self.proxies = {}
+
+    attr_accessor :namespace, :commands
+
+    def self.for(command)
+      proxies[command.namespace] ||= new(command.namespace)
+      proxy = proxies[command.namespace]
+      proxy.add_command(command)
+      proxy
+    end
+
+    def initialize(namespace)
+      @namespace = namespace
+      @commands = []
+    end
+
+    def add_command(command)
+      return if @commands.include?(command.action)
+      @commands << command.action
+      define_singleton_method(command.action, ->(options = {}) {
+        AppleBot.run_command(command.file_name, options)
+      })
+    end
+
+    def attach_to(klass)
+      return if klass.respond_to?(self.namespace)
+      namespace = self.namespace
+      klass.define_singleton_method(namespace) {
+        return AppleBot::CommandProxy.proxies[namespace]
+      }
+    end
+
+    def inspect
+      s = self.to_s.gsub(">", " ")
+      s << "commands: #{@commands.join(', ')}"
+      s << ">"
+      s
+    end
+
+  end
+end

data/lib/applebot/commands.rb

@@ -0,0 +1,74 @@
+module AppleBot
+  mattr_accessor :commands
+
+  class Command < Struct.new(:file_name, :namespace, :action, :description, :options)
+    def initialize(*properties)
+      options = properties.delete_at -1
+      super(*properties)
+      self.options = CommandOptionSet.new(options['required'], options['optional'])
+    end
+
+    def self.load_all!
+      commands_file_path = File.join(AppleBot.phantom_scripts_path, '_commands.json')
+      commands = JSON.parse(IO.read(commands_file_path))
+      AppleBot.commands = commands.keys.map {|file|
+        command_config = commands[file]
+        args = [file] + [
+          command_config['namespace'], command_config['action'],
+          command_config['description'], command_config['options']
+        ]
+        Command.new(*args)
+      }
+    end
+
+    def cli_command
+      "#{namespace}:#{action}"
+    end
+
+    def ruby_method
+      "#{action}_#{namespace}"
+    end
+  end
+
+  class CommandOptionSet < Struct.new(:required, :optional)
+    def initialize(required, optional)
+      fix_batch_options = lambda { |set, extras|
+        set.map {|o|
+          if o['batch']
+            o['keys'].map {|k|
+              h = {
+                'key' => k
+              }.merge(o)
+              h.delete 'keys'
+              h.delete 'batch'
+              h
+            }
+          else
+            o
+          end
+        }.flatten.map {|o|
+          o = o.merge(extras)
+          CommandOption.new(o['key'], o['description'], o['values'], o['default'], o['required'])
+        }
+      }
+      required = fix_batch_options.call(required, {'required' => true}) if required
+      required ||= []
+      optional = fix_batch_options.call(optional, {'required' => false}) if optional
+      optional ||= []
+      super(required, optional)
+    end
+  end
+
+  class CommandOption < Struct.new(:key, :description, :values, :default, :required)
+    def cli_description
+      s = ""
+      s << "REQUIRED " if required
+      s << "#{description}"
+      s.tap do |d|
+        d << " - VALUES: #{values}" if values
+        d << " - DEFAULT: #{default}" if default
+      end
+    end
+  end
+end
+AppleBot::Command.load_all!

data/lib/applebot/error.rb

@@ -0,0 +1,97 @@
+module AppleBot
+  class AppleBotError < StandardError
+    class_attribute :message
+    self.message = "Unspecified AppleBot error occured"
+    attr_reader :output, :html
+
+    def initialize(error, output = [], message = nil)
+      super(self.class.message)
+      output ||= []
+      output = output.map(&:strip).reject(&:blank?)
+      @html = output.select {|n|
+        is_debug_html?(n)
+      }.map { |s|
+        JSON.parse(s)['html']
+      }.first
+
+      @output = output.reject {|n|
+        is_debug_html?(n)
+      }
+
+      full_backtrace = (@output.map { |o|
+        "#{o}:in `AppleBot'"
+      } + error.backtrace).compact
+      set_backtrace(full_backtrace)
+    end
+
+    def is_debug_html?(line)
+      line.include?('"event":"debug_html"')
+    end
+  end
+
+  class AppIdNotFound < AppleBotError
+    self.message = "Could not find App Bundle ID in the HTML"
+  end
+
+  class AppleMaintenanceMode < AppleBotError
+    self.message = "Apple is currently in maintenance mode"
+  end
+
+  class AuthenticationError < AppleBotError
+    self.message = "Provided Apple ID credentials were incorrect"
+  end
+
+  class MultipleProfileError < AppleBotError
+    self.message = "Attempted to re-create an existing profile"
+  end
+
+  class AppNameTakenError < AppleBotError
+    self.message = "The app name you entered is taken"
+  end
+
+  class SignalTermination < StandardError
+    def initialize(status)
+      super("The process was terminated with signal #{status.termsig} (#{Signal.signame(status.termsig)})")
+    end
+  end
+
+  MESSAGE_FRAGMENT_TO_ERROR = {
+    "could not find App ID in options" => AppIdNotFound,
+    'class="maintenance"' => AppleMaintenanceMode,
+    'iTunes Connect is temporarily unavailable' => AppleMaintenanceMode,
+    'Your Apple ID or password was entered incorrectly' => AuthenticationError,
+    'Multiple profiles found with the name' => MultipleProfileError,
+    'The App Name you entered has already been used' => AppNameTakenError,
+  }
+
+  class AppleBotError
+    def self.for_output(output = [])
+      output ||= []
+
+      error_class = nil
+
+      output.each { |line|
+        MESSAGE_FRAGMENT_TO_ERROR.each { |message, klass|
+          if line.include?(message)
+            error_class = klass
+            break
+          end
+        }
+        break if error_class
+      }
+      error_class ||= AppleBotError
+
+      begin
+        # capture the Ruby-level stack trace
+        raise StandardError
+      rescue Exception => e
+        error_class.new(e, output)
+      end
+    end
+
+    def self.test
+      raise for_output(["something", "happened"])
+    end
+  end
+
+end

data/lib/applebot/mkmf.rb

@@ -0,0 +1,25 @@
+module AppleBot
+  module_function
+
+  # ripped from mkmf source
+  def find_executable(bin, path = nil)
+    ext = ""
+    if File.expand_path(bin) == bin
+      return bin if File.executable?(bin)
+      ext and File.executable?(file = bin + ext) and return file
+      return nil
+    end
+    if path ||= ENV['PATH']
+      path = path.split(File::PATH_SEPARATOR)
+    else
+      path = %w[/usr/local/bin /usr/ucb /usr/bin /bin]
+    end
+    file = nil
+    path.each do |dir|
+      return file if File.executable?(file = File.join(dir, bin))
+      return file if ext and File.executable?(file << ext)
+    end
+    nil
+  end
+
+end

data/lib/applebot/shell.rb

@@ -0,0 +1,79 @@
+module AppleBot
+  class Shell
+    def command(sys_command, verbose, format)
+      output = []
+      Open3.popen3(sys_command) do |stdin, stdout, stderr, wait_thr|
+        while line = (stdout.gets || stderr.gets)
+          output << line
+          if verbose === true
+            puts_format_line(line, format)
+          end
+        end
+        exit_status = wait_thr.value
+        output << JSON.generate(process_status: exit_status.inspect, thread: wait_thr.inspect)
+        if exit_status.termsig
+          raise SignalTermination.new(exit_status)
+        end
+        unless exit_status.success?
+          raise AppleBotError.for_output(output)
+        end
+      end
+
+      output.select {|o|
+        o.include?('"result":')
+      }.last
+    end
+
+    def puts_format_line(line, format)
+      json = JSON.parse(line)
+
+      case format.to_s
+      when 'json'
+        puts JSON.generate(json.except('normal_output'))
+      else
+        normal_output = json['normal_output']
+        return if normal_output.blank?
+        return if normal_output.include?("[phantom]")
+        puts(normal_output)
+      end
+    end
+
+    def result(output, format, print_result)
+      result = JSON.parse(output)['result']
+
+      case format.to_s
+      when 'pretty'
+        table(result).tap do |t|
+          puts t if print_result
+        end
+        true
+      else
+        result.tap do |json|
+          puts json if print_result
+        end
+      end
+    end
+
+    def table(data)
+      table = nil
+      if data.first && data.first[-1].is_a?(Hash)
+        headings = ['key'] + data.first[-1].keys
+        rows = data.to_a.map { |key_and_value|
+          row = []
+          headings.each do |heading|
+            if heading == 'key'
+              row << key_and_value[0]
+            else
+              row << key_and_value[1][heading]
+            end
+          end
+          row
+        }
+        table = Terminal::Table.new headings: headings, rows: rows
+      else
+        table = Terminal::Table.new rows: data.to_a
+      end
+      table
+    end
+  end
+end