apple_vpp 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adcdb9612aaa35734ab5e10326f5002494f64844
-  data.tar.gz: 1807d39e5144529eec881e42cf8e85b7633cb8ce
+  metadata.gz: 66e3f762a1be742576c657a6d8c7a597cf3a2952
+  data.tar.gz: 0a811283fbe9b3e3c18b8552f3cf9bad3aa8543d
 SHA512:
-  metadata.gz: 0125c4e4fef7f9936e3074724f854807995143737b102e7c5581b500a699e050e357490dfa2a309ebe991e3d31547f3027040367cacbd23d072b78491400d0fb
-  data.tar.gz: 81256495a17d68f7bf7737589d9277b89e4218e082e4ede1e48e7c00ec3016f9af3c040d0c9c444cd8b21004565242e9bb48a9d461ff6744f83aa33a0bf740d2
+  metadata.gz: 54a55e79df45d3b96f1414e262f48aaea2881765ee82091fa226dc06f8796936dac6549f889d1ad73d289e7e5c2fd17e7187bddd3de6ae066a952ed77c838715
+  data.tar.gz: 696437d6b02a2dc705a4f1059dd2e8471609af868543355744a0d558a90a65470269bb33eda8b95fe83bdf8019dc9c2b7c8a2b4843408e826233f7e483decc13

data/README.md

@@ -29,7 +29,7 @@ c = AppleVPP::Client.new s_token
 resp = c.get_users
 
 c.edit_user user_id: resp[:users].first[:user_id],
-            email:   'youremail@example.org' 	 
+            email:   'youremail@example.org'
 ```
 
 # Methods
@@ -38,7 +38,7 @@ For information beyond what is included here, refer to the "Mobile Device Manage
 
 ## associate_license_with_user
 
-One of these is required: 
+One of these is required:
 
 * user_id
 * client_user_id_str
@@ -76,6 +76,12 @@ Optional:
 
 * email
 
+## get_assets
+
+Optional:
+
+* include_license_counts
+
 ## get_licenses
 
 Optional:
@@ -102,6 +108,24 @@ Optional:
 * since_modified_token
 * include_retired
 
+## manage_licenses_by_adam_id_src
+
+Required:
+
+* adam_id_str
+* pricing_param
+
+One (and only one) of these are required:
+
+* associate_client_user_id_strs
+* associate_serial_numbers
+* disassociate_client_user_id_strs
+* disassociate_serial_numbers
+
+Optional:
+
+* notify_disassociation
+
 ## register_user
 
 Required:
@@ -121,6 +145,8 @@ One of these is required:
 
 # Error Handling
 
+## Apple API Errors
+
 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
@@ -129,6 +155,11 @@ AppleVPP::Error::Code#{error_code}
 
 A message will also be provided with the error.
 
+## 503 Service Unavailable Errors
+
+The Apple API service may return a `503 Service Unavailable` error if the service is overwhelmed or if your client is being too aggressive. In this scenario, `apple_vpp` will raise `AppleVPP::Error::ServiceUnavailable`. The raised error will include a method `.retry_in_seconds` which returns an integer value, in seconds, of how long you should wait before retrying your request. The raw `Retry-After` header that Apple returns is also available via `.retry_after`.
+
+
 ## Contributing
 
 1. Fork it

data/apple_vpp.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rest-client', '~> 1.6.7'
+  spec.add_dependency 'rest-client', '~> 1.8.0'
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/lib/apple_vpp/client.rb

@@ -65,6 +65,16 @@ module AppleVPP
       AppleSerializer.to_ruby resp['user']
     end
 
+    def get_assets(params = {})
+      body = {
+        'includeLicenseCounts' => params[:include_license_counts]
+      }
+
+      resp = request :get_vpp_assets_srv_url, body
+
+      AppleSerializer.to_ruby resp['assets']
+    end
+
     def get_licenses(params = {})
       licenses = []
       batch_token = nil
@@ -88,7 +98,7 @@ module AppleVPP
 
       end while batch_token
 
-      { 
+      {
         licenses:             AppleSerializer.to_ruby(licenses),
         since_modified_token: since_modified_token
       }
@@ -96,10 +106,10 @@ module AppleVPP
 
     def get_user(params = {})
       require_params [[:user_id, :client_user_id_str]], params
-     
+
       body = {
-        'userId'          => params[:user_id], 
-        'clientUserIdStr' => params[:client_user_id_str], 
+        'userId'          => params[:user_id],
+        'clientUserIdStr' => params[:client_user_id_str],
         'itsIdHash'       => params[:its_id_hash]
       }
 
@@ -108,6 +118,34 @@ module AppleVPP
       AppleSerializer.to_ruby resp['user']
     end
 
+    def manage_licenses_by_adam_id(params = {})
+      require_params [:adam_id_str, :pricing_param], params
+
+      unless params.has_key?(:associate_client_user_id_strs) ^
+             params.has_key?(:associate_serial_numbers) ^
+             params.has_key?(:disassociate_client_user_id_strs) ^
+             params.has_key?(:disassociate_license_id_strs)
+        raise ArgumentError, 'One and only one of these parameters may be provided: associate_client_user_id_strs, associate_serial_numbers, disassociate_client_user_id_strs, disassociate_license_id_strs.'
+      end
+
+      body = {
+        'adamIdStr'                    => params[:adam_id_str],
+        'associateClientUserIdStrs'    => params[:associate_client_user_id_strs],
+        'associateSerialNumbers'       => params[:associate_serial_numbers],
+        'disassociateClientUserIdStrs' => params[:disassociate_client_user_id_strs],
+        'disassociateLicenseIdStrs'    => params[:disassociate_license_id_strs],
+        'pricingParam'                 => params[:pricing_param],
+        'notifyDisassociation'         => params[:notify_disassociation]
+      }
+
+      resp = request :manage_vpp_licenses_by_adam_id_srv_url, body
+
+      ret = AppleSerializer.to_ruby resp
+      ret.delete(:status)
+
+      ret
+    end
+
     def register_user(params = {})
       require_params :client_user_id_str, params
 
@@ -117,7 +155,7 @@ module AppleVPP
       }
 
       resp = request :register_user_srv_url, body
-    
+
       AppleSerializer.to_ruby resp['user']
     end
 
@@ -153,21 +191,21 @@ module AppleVPP
 
         batch_token = resp['batchToken']
         since_modified_token = resp['sinceModifiedToken']
-      
+
       end while batch_token
 
-      { 
+      {
         users:                AppleSerializer.to_ruby(users),
         since_modified_token: since_modified_token
       }
     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 = [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)
@@ -179,7 +217,7 @@ module AppleVPP
             break
           end
         end
-        
+
         unless param_found
           raise ArgumentError, "#{param_names.join(' or ')} must be provided"
         end

data/lib/apple_vpp/error.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 module AppleVPP
   class Error < ::StandardError
 
@@ -9,5 +11,22 @@ module AppleVPP
       self.const_set "Code#{code}", ( Class.new AppleVPP::Error )
     end
 
+    class ServiceUnavailable
+      attr_accessor :retry_after
+
+      def initialize retry_after
+        @retry_after = retry_after
+      end
+
+      def retry_in_seconds
+        if @retry_after == @retry_after.to_i.to_s
+          @retry_after
+        else
+          Time.parse(@retry_after) - Time.now
+        end
+      end
+
+    end
+
   end
 end

data/lib/apple_vpp/request.rb

@@ -7,12 +7,26 @@ module AppleVPP
     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
+require 'awesome_print'
+ap body
+      begin
+
+        resp = RestClient.post url, body, content_type: :json
+
+      rescue RestClient::ExceptionWithResponse => e
+
+        unless e.response.code == 503
+          raise e
+        end
+
+        raise AppleVPP::Error::ServiceUnavailable.new(e.response.raw_headers['Retry-After'])
+
+      end
+
       json = JSON.parse(resp)
 
       if json['status'] == -1
-        raise (eval "AppleVPP::Error::Code#{json['errorNumber']}"), json['errorMessage'] 
+        raise (eval "AppleVPP::Error::Code#{json['errorNumber']}"), json['errorMessage']
       end
 
       json

data/lib/apple_vpp/url_service.rb

@@ -7,10 +7,12 @@ module AppleVPP
                 :client_config_srv_url,
                 :disassociate_license_srv_url,
                 :edit_user_srv_url,
+                :get_vpp_assets_srv_url,
                 :get_licenses_srv_url,
                 :get_user_srv_url,
                 :get_users_srv_url,
                 :invitation_email_url,
+                :manage_vpp_licenses_by_adam_id_srv_url,
                 :register_user_srv_url,
                 :retire_user_srv_url,
                 :vpp_website_url,
@@ -25,17 +27,19 @@ module AppleVPP
       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']
+      @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_vpp_assets_srv_url                 = resp['getVPPAssetsSrvUrl']
+      @get_licenses_srv_url                   = resp['getLicensesSrvUrl']
+      @get_user_srv_url                       = resp['getUserSrvUrl']
+      @get_users_srv_url                      = resp['getUsersSrvUrl']
+      @invitation_email_url                   = resp['invitationEmailUrl']
+      @manage_vpp_licenses_by_adam_id_srv_url = resp['manageVPPLicensesByAdamIdSrvUrl']
+      @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']
@@ -50,3 +54,4 @@ module AppleVPP
 
   end
 end
+

data/lib/apple_vpp/version.rb

@@ -1,3 +1,3 @@
 module AppleVPP
-  VERSION = "3.0.2"
+  VERSION = "3.1.0"
 end

data/spec/apple_vpp/api_spec.rb

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

data/spec/spec_helper.rb

@@ -10,7 +10,6 @@ require 'apple_vpp'
 #
 # 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
 

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: apple_vpp
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Taylor Boyko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2015-07-09 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
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: 1.8.0
 - !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
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -102,17 +102,17 @@ 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.0.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Apple VPP App Assignment API