apple_vpp 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Njk4MWU4NzhlZWMwM2M2MTNjNDYxNDUxYjhiNWQwMDg0OTVmNDliZA==
+  data.tar.gz: !binary |-
+    ZGY5YWEwZTIzM2UwODY3NGM5NjIyYzk1MTE4NWFjMGI0ZWExNDFiMw==
+SHA512:
+  metadata.gz: !binary |-
+    ZmJjNjNlNTZmYzBhNWIyZWM1NmZhM2M3ZDM0NDY1NTk2MTkzNGY1MTIyNWY4
+    MzFjNmFmYTVmNDViNzQ0ZjUxYzY2NGRmMmJjMTRiNzdlYWQ0M2JlZDBkNmVj
+    OWNlNWQyYjVjYzM5MDAzYzU1OTc3NDU5OWZjM2QzNmZiNjcyNmU=
+  data.tar.gz: !binary |-
+    NDZiNmYxMzdmYWE0MWNiNTY2ZDEyNWVlM2IyOTkxODMzYmZmNWI5Y2ViZGIx
+    ZTRkZDMxMTVlY2VlZDZkOGVkODgxMTY4Njc0Mzc4NDUzNDEwNTgxYjI0NzMx
+    Mjc3YWY4M2E5MWFjZWZiNzYwNGI1NGMzOTJjZTI1MzU5NzZkMTQ=

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    apple_vpp (1.0.0)
+      rest-client (~> 1.6.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    mime-types (1.25)
+    rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  apple_vpp!
+  bundler (~> 1.3)
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 tboyko
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+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,138 @@
+apple_vpp
+=========
+
+Ruby bindings for the Apple VPP Managed App License Distribution API.
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'apple_vpp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apple_vpp
+
+# Usage
+
+Use the library like this:
+
+```ruby
+s_token = File.read './from_apple_portal.vpptoken'
+
+c = AppleVPP::Client.new s_token
+
+users_json = c.get_users
+
+c.edit_user user_id: users_json.first[:user_id],
+            email:   'youremail@example.org' 	 
+```
+
+# Methods
+
+For information beyond what is included here, refer to the "Mobile Device Management Protocol Reference" documentation on Apple's Developer site.
+
+## associate_license_with_user
+
+One of these is required: 
+
+* user_id
+* client_user_id_str
+
+One of these is required:
+
+* adam_id
+* license_id
+
+Optional:
+
+* pricing_param
+
+## client_config
+
+Optional:
+
+* client_context
+* apn_token
+
+## disassociate_license_from_user
+
+Required:
+
+* license_id
+
+## edit_user
+
+One of these is required:
+
+* user_id
+* client_user_id_str
+
+Optional:
+
+* email
+
+## get_licenses
+
+Optional:
+
+* since_modified_token
+* adam_id
+* pricing_param
+
+## get_user
+
+One of these is required:
+
+* user_id
+* client_user_id_str
+
+Optional:
+
+* its_id_hash
+
+## get_users
+
+Optional:
+
+* since_modified_token
+* include_retired
+
+## register_user
+
+Required:
+
+* client_user_id_str
+
+Optional:
+
+* email
+
+## retire_user
+
+One of these is required:
+
+* user_id
+* client_user_id_str
+
+# Error Handling
+
+Should an error be reported by the Apple API service, the library will raise a custom error class that will correspond to the Apple error code like so:
+
+```ruby
+AppleVPP::Error::Code#{error_code}
+```
+
+A message will also be provided with the error.
+
+## 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

data/Rakefile

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

data/apple_vpp.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apple_vpp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apple_vpp"
+  spec.version       = AppleVPP::VERSION
+  spec.authors       = ["Taylor Boyko"]
+  spec.email         = ["taylorboyko@gmail.com"]
+  spec.description   = %q{Ruby bindings for the Apple VPP App Assignment API}
+  spec.summary       = %q{Ruby bindings for the Apple VPP App Assignment API}
+  spec.homepage      = ""
+  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 'rest-client', '~> 1.6.7'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/apple_vpp/apple_serializer.rb

@@ -0,0 +1,19 @@
+module AppleVPP
+  class AppleSerializer
+    
+    def self.to_ruby(apple_hash)
+      if apple_hash.kind_of?( Array )
+        return apple_hash.collect { |i| to_ruby i }
+      end
+      
+      keys_with_hashes = apple_hash.select { | _k, v | v.kind_of?( Hash ) }
+
+      if keys_with_hashes.count > 0
+        keys_with_hashes.each { |k, v| apple_hash[k] = to_ruby v }
+      end
+
+      Hash[ apple_hash.map { | k, v | [ k.underscore.to_sym, v ] } ]
+    end
+
+  end
+end

data/lib/apple_vpp/client.rb

@@ -0,0 +1,187 @@
+require 'rest_client'
+require 'json'
+
+module AppleVPP
+  class Client
+
+    attr_accessor :s_token
+
+    def initialize(s_token)
+      @s_token = s_token
+      @url_service = UrlService.new
+    end
+
+    def associate_license_with_user(params = {})
+      require_params [[:user_id, :client_user_id_str], [:adam_id, :license_id]], params
+
+      body = {
+        'userId'          => params[:user_id],
+        'clientUserIdStr' => params[:client_user_id_str],
+        'adamId'          => params[:adam_id],
+        'licenseId'       => params[:license_id],
+        'pricingParam'    => params[:pricing_param]
+      }
+
+      resp = request :associate_license_srv_url, body
+
+      AppleSerializer.to_ruby [ resp['license'], resp['user'] ]
+    end
+
+    def disassociate_license_from_user(params = {})
+      require_params :license_id, params
+
+      body = {
+        'licenseId' => params[:license_id]
+      }
+
+      resp = request :disassociate_license_srv_url, body
+
+      AppleSerializer.to_ruby [ resp['license'], resp['user'] ]
+    end
+
+    def client_config(params = {})
+      body = {
+        'clientContext' => params[:client_context],
+        'apnToken'      => params[:apn_token]
+      }
+
+      resp = request :client_config_srv_url, body
+
+      AppleSerializer.to_ruby resp['clientContext']
+    end
+
+    def edit_user(params = {})
+      require_params [[:user_id, :client_user_id_str]], params
+
+      body = {
+        'userId'          => params[:user_id],
+        'clientUserIdStr' => params[:client_user_id_str],
+        'email'           => params[:email]
+      }
+
+      resp = request :edit_user_srv_url, body
+
+      AppleSerializer.to_ruby resp['user']
+    end
+
+    def get_licenses(params = {})
+      licenses = []
+      batch_token = nil
+
+      begin
+
+        body = {
+          'batchToken'          => batch_token,
+          'sinceModifiedToken'  => params[:since_modified_token],
+          'adamId'              => params[:adam_id],
+          'pricingParam'        => params[:pricing_param]
+        }
+
+        resp = request :get_licenses_srv_url, body
+
+        licenses.concat( resp['licenses'] ) if resp['licenses']
+
+        batch_token = resp['batchToken']
+
+      end while batch_token
+
+      AppleSerializer.to_ruby licenses
+    end
+
+    def get_user(params = {})
+      require_params [[:user_id, :client_user_id_str]], params
+     
+      body = {
+        'userId'          => params[:user_id], 
+        'clientUserIdStr' => params[:client_user_id_str], 
+        'itsIdHash'       => params[:its_id_hash]
+      }
+
+      resp = request :get_user_srv_url, body
+
+      AppleSerializer.to_ruby resp['user']
+    end
+
+    def register_user(params = {})
+      require_params :client_user_id_str, params
+
+      body = {
+        'clientUserIdStr' => params[:client_user_id_str],
+        'email'           => params[:email]
+      }
+
+      resp = request :register_user_srv_url, body
+    
+      AppleSerializer.to_ruby resp['user']
+    end
+
+    def retire_user(params = {})
+      require_params [[:user_id, :client_user_id_str]], params
+
+      body = {
+        'userId'          => params[:user_id],
+        'clientUserIdStr' => params[:client_user_id_str]
+      }
+
+      resp = request :retire_user_srv_url, body
+
+      AppleSerializer.to_ruby resp['user']
+    end
+
+    def get_users(params = {})
+      users = []
+      batch_token = nil
+
+      begin
+
+        body = {
+          'batchToken'          => batch_token,
+          'sinceModifiedToken'  => params[:since_modified_token],
+          'includeRetired'      => params[:include_retired] ? 1 : nil
+        }
+
+        resp = request :get_users_srv_url, body
+
+        users.concat( resp['users'] ) if resp['users']
+
+        batch_token = resp['batchToken']
+
+      end while batch_token
+
+      AppleSerializer.to_ruby users
+    end
+
+    private
+    
+    # param_name_array is an array of required parameters. Include a sub-array of parameters for || requirement.
+
+    def require_params param_name_array, params
+      param_name_array = [param_name_array] unless param_name_array.kind_of? Array 
+
+      param_name_array.each do |param_names|
+        param_names = [param_names] unless param_names.kind_of?(Array)
+
+        param_found = false
+        param_names.each do |param_name|
+          if params[param_name]
+            param_found = true
+            break
+          end
+        end
+        
+        unless param_found
+          raise ArgumentError, "#{param_names.join(' or ')} must be provided"
+        end
+      end
+    end
+
+    def request url_service_url, body
+      @url_service.refresh unless @url_service.ready?
+
+      url = @url_service.send( url_service_url )
+
+      Request.submit url, @s_token, body
+    end
+
+  end
+end

data/lib/apple_vpp/error.rb

@@ -0,0 +1,14 @@
+module AppleVPP
+  module Error
+
+    def self.create_error_class code
+      class_name = "Code#{code}"
+      begin
+        Module.const_get(class_name)
+        self.const_set class_name, ( Class.new StandardError )
+      rescue NameError
+      end
+    end
+
+  end
+end

data/lib/apple_vpp/request.rb

@@ -0,0 +1,23 @@
+require 'rest-client'
+require 'json'
+
+module AppleVPP
+  class Request
+
+    def self.submit( url, s_token = nil, body = {} )
+      body['sToken'] = s_token
+      body.delete_if { |_k, v| v.nil? }
+      
+      resp = RestClient.post url, body, content_type: :json
+      json = JSON.parse(resp)
+
+      if json['status'] == -1
+        raise (eval "AppleVPP::Error::Code#{json['errorNumber']}"), json['errorMessage'] 
+      end
+
+      json
+    end
+
+  end
+end
+

data/lib/apple_vpp/url_service.rb

@@ -0,0 +1,56 @@
+module AppleVPP
+  class UrlService
+
+    SERVICE_URL = 'https://vpp.itunes.apple.com/WebObjects/MZFinance.woa/wa/'
+
+    attr_reader :associate_license_srv_url,
+                :client_config_srv_url,
+                :disassociate_license_srv_url,
+                :edit_user_srv_url,
+                :get_licenses_srv_url,
+                :get_user_srv_url,
+                :get_users_srv_url,
+                :invitation_email_url,
+                :register_user_srv_url,
+                :retire_user_srv_url,
+                :vpp_website_url,
+                :errors
+
+    def initialize
+      @errors = {}
+      @ready  = false
+    end
+
+    def refresh
+      url = "#{SERVICE_URL}VPPServiceConfigSrv"
+      resp = Request.submit url
+
+      @associate_license_srv_url    = resp['associateLicenseSrvUrl']
+      @client_config_srv_url        = resp['clientConfigSrvUrl']
+      @disassociate_license_srv_url = resp['disassociateLicenseSrvUrl']
+      @edit_user_srv_url            = resp['editUserSrvUrl']
+      @get_licenses_srv_url         = resp['getLicensesSrvUrl']
+      @get_user_srv_url             = resp['getUserSrvUrl']
+      @get_users_srv_url            = resp['getUsersSrvUrl']
+      @invitation_email_url         = resp['invitationEmailUrl']
+      @register_user_srv_url        = resp['registerUserSrvUrl']
+      @retire_user_srv_url          = resp['retireUserSrvUrl']
+      @vpp_website_url              = resp['vppWebsiteUrl']
+
+      resp['errorCodes'].each do |i|
+        @errors[ i['errorNumber'] ] = i['errorMessage']
+      end
+
+      @errors.each do | number, _message| 
+        AppleVPP::Error.create_error_class( number )
+      end
+
+      @ready = true
+    end
+
+    def ready?
+      @ready
+    end
+
+  end
+end

data/lib/apple_vpp/version.rb

@@ -0,0 +1,3 @@
+module AppleVPP
+  VERSION = "1.0.0"
+end

data/lib/apple_vpp.rb

@@ -0,0 +1,3 @@
+require 'core_ext/string'
+
+Dir[File.join(File.dirname(__FILE__), 'apple_vpp', '**', '*.rb')].each {|file| require file }

data/lib/core_ext/string.rb

@@ -0,0 +1,9 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end

data/spec/apple_vpp/api_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe AppleVPP::API do
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'apple_vpp' 
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  #config.order = 'random'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: apple_vpp
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Taylor Boyko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Ruby bindings for the Apple VPP App Assignment API
+email:
+- taylorboyko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- apple_vpp.gemspec
+- lib/apple_vpp.rb
+- lib/apple_vpp/apple_serializer.rb
+- lib/apple_vpp/client.rb
+- lib/apple_vpp/error.rb
+- lib/apple_vpp/request.rb
+- lib/apple_vpp/url_service.rb
+- lib/apple_vpp/version.rb
+- lib/core_ext/string.rb
+- spec/apple_vpp/api_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Apple VPP App Assignment API
+test_files:
+- spec/apple_vpp/api_spec.rb
+- spec/spec_helper.rb