moki_ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0a94a38cb0b659e29af3ca6bc390e3b9cb78dd4
-  data.tar.gz: 0209ee2b6262b17e228d0ba671672c92400af57a
+  metadata.gz: f5ba3120c5be2062512bc20651093e5402fd3fdc
+  data.tar.gz: f1e93594ead22b828771831e598b92563ba41424
 SHA512:
-  metadata.gz: 82bc152c026cfe0a9fe5333c2a7b58da1ff675d73c787c84ea2a48b4eb7afabff579797057fdf51db81b07b38df11b9e57306602b5850b4cb01a016ab167dd7e
-  data.tar.gz: ca891aa084ef3673b5b34275228ac2b8424550d3dca0112468ef2e2f3197de0514b1d448f87e8802fd039df15dc2378296a8c679479225c93aed6fbed44fad2a
+  metadata.gz: 9123325638bc9404e6daec6ded483abeb8466337419a4c4bccb22f08eaade74b3d831891882656f5c8d43ac7905675b65e4c67a16f1d9b10ea6ee2ca221d8705
+  data.tar.gz: 752c6cef9f5181924164baab86792c92913bcb76bdae42f11af7a232e8b9365b9f847969fca10c4d75caa6ec4e5c67ffd74c7b5aa58bcff1903e7c4b817eeacf

data/Gemfile.lock

@@ -1,28 +1,29 @@
 PATH
   remote: .
   specs:
-    moki_ruby (0.0.1)
+    moki_ruby (0.0.3)
       celluloid
       celluloid-io
       faraday
       faraday_middleware
       hashie
+      require_all
 
 GEM
   remote: https://rubygems.org/
   specs:
     celluloid (0.16.0)
       timers (~> 4.0.0)
-    celluloid-io (0.16.1)
+    celluloid-io (0.16.2)
       celluloid (>= 0.16.0)
-      nio4r (>= 1.0.0)
+      nio4r (>= 1.1.0)
     coderay (1.1.0)
     diff-lcs (1.2.5)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.9.1)
       faraday (>= 0.7.4, < 0.10)
-    hashie (3.3.2)
+    hashie (3.4.0)
     hitimes (1.2.2)
     method_source (0.8.2)
     multipart-post (2.0.0)
@@ -32,6 +33,7 @@ GEM
       method_source (~> 0.8.1)
       slop (~> 3.4)
     rake (10.4.2)
+    require_all (1.3.2)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)

data/README.md

@@ -3,8 +3,8 @@
 [![travis-status](https://travis-ci.org/bellycard/moki_ruby.svg)](https://travis-ci.org/bellycard/moki_ruby) [![Gem
 Version](https://badge.fury.io/rb/moki_ruby.svg)](http://badge.fury.io/rb/moki_ruby)
 
-A ruby gem for interacting with the Moki API, as a part of Moki Total
-Control and Moki Management.
+A ruby gem for interacting with the Moki API, as a part of
+[Moki Total Control](http://www.moki.com) and Moki Management.
 
 ## Installation
 
@@ -69,6 +69,21 @@ Using this device, there are several methods available:
 - `device.get_action(action_id)` will take in an `id` from an `Action`
   object, and return an updated `Action` object.
 
+## To do
+
+- Handle cases where device is not found
+- Handle error cases
+- Confirm if profile is on device before adding/removing
+- Confirm if app is on device before installing
+- Add new Moki endpoints
+
+## Special Thanks
+
+Thank you to the Moki team ([GitHub](https://github.com/MokiMobility)),
+especially [Jared](https://github.com/jaredblake),
+[Sam](https://github.com/mokiSam), and
+[Sam](https://github.com/sroskelley).
+
 ## Contributing
 
 1. Fork it ( https://github.com/bellycard/moki_ruby/fork )

data/lib/moki_ruby.rb

@@ -1,4 +1,5 @@
-require "moki_ruby/version"
+require 'require_all'
+require_rel "./"
 
 module MokiRuby
   def self.ios_profiles

data/lib/moki_ruby/action.rb

@@ -1,33 +1,35 @@
-class Action
-  attr_accessor :id, :last_seen, :action, :status, :client_name, :item_name, :third_party_user, :payload, :note
+module MokiRuby
+  class Action
+    attr_accessor :id, :last_seen, :action, :status, :client_name, :item_name, :third_party_user, :payload, :note
 
-  def self.from_hash(input_hash)
-    new_action = self.new
+    def self.from_hash(input_hash)
+      new_action = self.new
 
-    new_action.id = input_hash["id"]
-    new_action.last_seen = input_hash["lastSeen"]
-    new_action.action = input_hash["action"]
-    new_action.status = input_hash["status"]
-    new_action.client_name = input_hash["clientName"]
-    new_action.item_name = input_hash["itemName"]
-    new_action.third_party_user = input_hash["thirdPartyUser"]
-    new_action.payload = input_hash["payload"]
-    new_action.note = input_hash["note"]
+      new_action.id = input_hash["id"]
+      new_action.last_seen = input_hash["lastSeen"]
+      new_action.action = input_hash["action"]
+      new_action.status = input_hash["status"]
+      new_action.client_name = input_hash["clientName"]
+      new_action.item_name = input_hash["itemName"]
+      new_action.third_party_user = input_hash["thirdPartyUser"]
+      new_action.payload = input_hash["payload"]
+      new_action.note = input_hash["note"]
 
-    new_action
-  end
+      new_action
+    end
 
-  def to_hash
-    {
-      "id" => self.id,
-      "lastSeen" => self.last_seen,
-      "action" => self.action,
-      "status" => self.status,
-      "clientName" => self.client_name,
-      "itemName" => self.item_name,
-      "thirdPartyUser" => self.third_party_user,
-      "payload" => self.payload,
-      "note" => self.note
-    }
+    def to_hash
+      {
+        "id" => self.id,
+        "lastSeen" => self.last_seen,
+        "action" => self.action,
+        "status" => self.status,
+        "clientName" => self.client_name,
+        "itemName" => self.item_name,
+        "thirdPartyUser" => self.third_party_user,
+        "payload" => self.payload,
+        "note" => self.note
+      }
+    end
   end
 end

data/lib/moki_ruby/device_managed_app.rb

@@ -1,20 +1,22 @@
-class DeviceManagedApp
-  attr_accessor :status, :app_identifier, :management_flags
+module MokiRuby
+  class DeviceManagedApp
+    attr_accessor :status, :app_identifier, :management_flags
 
-  def self.from_hash(input_hash)
-    new_app = self.new
-    new_app.status = input_hash['Status']
-    new_app.app_identifier = input_hash['appIdentifier']
-    new_app.management_flags = input_hash['ManagementFlags']
+    def self.from_hash(input_hash)
+      new_app = self.new
+      new_app.status = input_hash['Status']
+      new_app.app_identifier = input_hash['appIdentifier']
+      new_app.management_flags = input_hash['ManagementFlags']
 
-    new_app
-  end
+      new_app
+    end
 
-  def to_hash
-    {
-      "Status" => self.status,
-      "appIdentifier" => self.app_identifier,
-      "ManagementFlags" => self.management_flags
-    }
+    def to_hash
+      {
+        "Status" => self.status,
+        "appIdentifier" => self.app_identifier,
+        "ManagementFlags" => self.management_flags
+      }
+    end
   end
 end

data/lib/moki_ruby/iosprofile.rb

@@ -1,46 +1,48 @@
-class IOSProfile
-  attr_accessor :id, :last_seen, :name, :display_name, :description, :identifier
+module MokiRuby
+  class IOSProfile
+    attr_accessor :id, :last_seen, :name, :display_name, :description, :identifier
 
-  def self.from_hash(input_hash)
-    new_profile = self.new
-    new_profile.id = input_hash["id"]
-    new_profile.last_seen = input_hash["lastSeen"]
-    new_profile.name = input_hash["name"]
-    new_profile.display_name = input_hash["displayName"]
-    new_profile.description = input_hash["description"]
-    new_profile.identifier = input_hash["identifier"]
+    def self.from_hash(input_hash)
+      new_profile = self.new
+      new_profile.id = input_hash["id"]
+      new_profile.last_seen = input_hash["lastSeen"]
+      new_profile.name = input_hash["name"]
+      new_profile.display_name = input_hash["displayName"]
+      new_profile.description = input_hash["description"]
+      new_profile.identifier = input_hash["identifier"]
 
-    new_profile
-  end
+      new_profile
+    end
 
-  def to_hash
-    {
-      "id" => self.id,
-      "lastSeen" => self.last_seen,
-      "name" => self.name,
-      "displayName" => self.display_name,
-      "description" => self.description,
-      "identifier" => self.identifier
-    }
-  end
+    def to_hash
+      {
+        "id" => self.id,
+        "lastSeen" => self.last_seen,
+        "name" => self.name,
+        "displayName" => self.display_name,
+        "description" => self.description,
+        "identifier" => self.identifier
+      }
+    end
 
-  def install_hash
-    actionable_hash.merge({ "action" => "installprofile",
-                            "payload" => "{#{ self.id }}" })
-  end
+    def install_hash
+      actionable_hash.merge({ "action" => "installprofile",
+                              "payload" => "{#{ self.id }}" })
+    end
 
-  def removal_hash
-    actionable_hash.merge({ "action" => "removeprofile",
-                            "payload" => "{#{ self.identifier }}" })
-  end
+    def removal_hash
+      actionable_hash.merge({ "action" => "removeprofile",
+                              "payload" => "{#{ self.identifier }}" })
+    end
 
-private
-  def actionable_hash
-    {
-      "thirdPartyUser" => "moki_ruby",
-      "clientName" => "MokiRuby",
-      "itemName" => self.name,
-      "notify" => true
-    }
+  private
+    def actionable_hash
+      {
+        "thirdPartyUser" => "moki_ruby",
+        "clientName" => "MokiRuby",
+        "itemName" => self.name,
+        "notify" => true
+      }
+    end
   end
 end

data/lib/moki_ruby/moki_api.rb

@@ -0,0 +1,118 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'celluloid/io'
+require 'moki_ruby/future_wrapper'
+require 'hashie'
+
+module MokiRuby
+  class MokiAPI
+    include Celluloid::IO
+    BASE_URL = '/rest/v1/api/tenants/'
+
+    def self.ios_profiles
+      issue_request(:get, full_url('/iosprofiles'), {})
+    end
+
+    def self.device_profile_list(device_id)
+      issue_request(:get, full_url("/devices/#{ device_id }/profiles"), {})
+    end
+
+    def self.tenant_managed_app_list
+      issue_request(:get, full_url('/iosmanagedapps'), {})
+    end
+
+    def self.device_managed_app_list(device_id)
+      issue_request(:get, full_url("/devices/#{ device_id }/managedapps"), {})
+    end
+
+    def self.perform_action(device_id, body_hash)
+      issue_request(:put, full_url("/devices/#{ device_id }/actions"), body_hash)
+    end
+
+    def self.action(device_id, action_id)
+      issue_request(:get, full_url("/devices/#{ device_id }/actions/#{ action_id }"), {})
+    end
+
+    def self.full_url(path)
+      raise "No Moki URL Provided. Set ENV['MOKI_API_URL']."    if ENV['MOKI_API_URL'].nil? || ENV['MOKI_API_URL'].empty?
+      raise "No Tenant ID Provided. Set ENV['MOKI_TENANT_ID']." if ENV['MOKI_TENANT_ID'].nil? || ENV['MOKI_TENANT_ID'].empty?
+
+      ENV['MOKI_API_URL'] + BASE_URL + ENV['MOKI_TENANT_ID'] + path
+    end
+
+    def self.issue_request(method, url, options)
+      raise "No API Key Provided. Set ENV['MOKI_API_KEY']."     if ENV['MOKI_API_KEY'].nil? || ENV['MOKI_API_KEY'].empty?
+
+      future = Celluloid::Future.new do
+        begin
+          log_request(method, url)
+          response = conn.send(method, url, options) do |request|
+            request.headers = request.headers.merge(headers)
+          end
+          to_return_type response
+        rescue => e
+          Honeybadger.notify(e, context: { method: method,
+                                           url: url,
+                                           options: options,
+                                           response_status: response.try(:status),
+                                           response_body: response.try(:body) }) if defined?(Honeybadger)
+          raise e
+        end
+      end
+      future.extend(FutureWrapper)
+    end
+
+    def issue_request(method, url, options)
+      self.class.issue_request(method, url, options)
+    end
+
+  private
+    def self.to_return_type response
+      begin
+        Hashie::Mash.new({
+          body: JSON.parse(response.body),
+          status: response.status,
+          headers: response.headers
+        })
+      rescue
+        response
+      end
+    end
+
+    def self.conn
+      connection = Faraday.new do |conn|
+        conn.request :json
+        conn.adapter Faraday.default_adapter
+      end
+      connection
+    end
+
+    def self.headers
+      {
+        "X-Moki-TenantAPIToken" => ENV['MOKI_API_KEY']
+      }
+    end
+
+    def self.log_request(method, url)
+      logger = if defined?(Rails)
+                 Rails.logger
+               elsif defined?(Napa::Logger)
+                 Napa::Logger.logger
+               else
+                 nil
+               end
+
+      return unless logger
+
+      data = { moki_api_request:
+        {
+          message: "Calling Moki API URL #{ url }",
+          request_method: method,
+          request_url: url,
+        }
+      }
+
+      logger.info(data.as_json)
+    end
+  end
+end

data/lib/moki_ruby/tenant_managed_app.rb

@@ -1,56 +1,58 @@
-class TenantManagedApp
-  attr_accessor :id, :last_seen, :name, :identifier, :version,
-                :management_flags, :itunes_store_id, :manifest_url
+module MokiRuby
+  class TenantManagedApp
+    attr_accessor :id, :last_seen, :name, :identifier, :version,
+                  :management_flags, :itunes_store_id, :manifest_url
 
-  def self.from_hash(input_hash)
-    new_app = self.new
-    new_app.id = input_hash["id"]
-    new_app.last_seen = input_hash["lastSeen"]
-    new_app.name = input_hash["name"]
-    new_app.identifier = input_hash["identifier"]
-    new_app.version = input_hash["version"]
-    new_app.management_flags = input_hash["ManagementFlags"]
-    new_app.itunes_store_id = input_hash["iTunesStoreID"]
-    new_app.manifest_url = input_hash["ManifestURL"]
+    def self.from_hash(input_hash)
+      new_app = self.new
+      new_app.id = input_hash["id"]
+      new_app.last_seen = input_hash["lastSeen"]
+      new_app.name = input_hash["name"]
+      new_app.identifier = input_hash["identifier"]
+      new_app.version = input_hash["version"]
+      new_app.management_flags = input_hash["ManagementFlags"]
+      new_app.itunes_store_id = input_hash["iTunesStoreID"]
+      new_app.manifest_url = input_hash["ManifestURL"]
 
-    new_app
-  end
+      new_app
+    end
 
-  def to_hash
-    { "id" => self.id,
-      "lastSeen" => self.last_seen,
-      "name" => self.name,
-      "identifier" => self.identifier,
-      "version" => self.version,
-      "ManagementFlags" => self.management_flags,
-      "iTunesStoreID" => self.itunes_store_id,
-      "ManifestURL" => self.manifest_url }
-  end
+    def to_hash
+      { "id" => self.id,
+        "lastSeen" => self.last_seen,
+        "name" => self.name,
+        "identifier" => self.identifier,
+        "version" => self.version,
+        "ManagementFlags" => self.management_flags,
+        "iTunesStoreID" => self.itunes_store_id,
+        "ManifestURL" => self.manifest_url }
+    end
 
-  def install_hash
-    {
-      "action" => "install_app",
-      "thirdPartyUser" => "moki_ruby",
-      "clientName" => "MokiRuby",
-      "itemName" => self.name,
-      "notify" => true,
-      "payload" => {
-                     "ManagementFlags" => self.management_flag,
-                     "identifier" => self.identifier,
-                     "version" => self.version
-                   }.merge(self.external_locator_hash)
-    }
-  end
+    def install_hash
+      {
+        "action" => "install_app",
+        "thirdPartyUser" => "moki_ruby",
+        "clientName" => "MokiRuby",
+        "itemName" => self.name,
+        "notify" => true,
+        "payload" => {
+                       "ManagementFlags" => self.management_flag,
+                       "identifier" => self.identifier,
+                       "version" => self.version
+                     }.merge(self.external_locator_hash)
+      }
+    end
 
-  def management_flag
-    (!manifest_url.nil? && manifest_url != "") ? 1 : 0
-  end
+    def management_flag
+      (!manifest_url.nil? && manifest_url != "") ? 1 : 0
+    end
 
-  def external_locator_hash
-    if manifest_url && manifest_url != ""
-      { "ManifestURL" => manifest_url }
-    else
-      { "iTunesStoreID" => itunes_store_id }
+    def external_locator_hash
+      if manifest_url && manifest_url != ""
+        { "ManifestURL" => manifest_url }
+      else
+        { "iTunesStoreID" => itunes_store_id }
+      end
     end
   end
 end

data/lib/moki_ruby/version.rb

@@ -1,3 +1,3 @@
 module MokiRuby
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/moki_ruby.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'celluloid'
   spec.add_dependency 'celluloid-io'
   spec.add_dependency 'hashie'
+  spec.add_dependency 'require_all'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/spec/lib/moki_api_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'moki_api'
+require 'moki_ruby/moki_api'
 
 describe MokiAPI do
   describe "missing env variable" do

data/spec/spec_helper.rb

@@ -19,3 +19,5 @@ RSpec.configure do |config|
   config.order = :random
   Kernel.srand config.seed
 end
+
+include MokiRuby

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moki_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Trey Springer
@@ -80,6 +80,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -151,13 +165,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/future_wrapper.rb
-- lib/moki_api.rb
 - lib/moki_ruby.rb
 - lib/moki_ruby/action.rb
 - lib/moki_ruby/device.rb
 - lib/moki_ruby/device_managed_app.rb
+- lib/moki_ruby/future_wrapper.rb
 - lib/moki_ruby/iosprofile.rb
+- lib/moki_ruby/moki_api.rb
 - lib/moki_ruby/tenant_managed_app.rb
 - lib/moki_ruby/version.rb
 - moki_ruby.gemspec

data/lib/moki_api.rb

@@ -1,116 +0,0 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'celluloid/io'
-require 'future_wrapper'
-require 'hashie'
-
-class MokiAPI
-  include Celluloid::IO
-  BASE_URL = '/rest/v1/api/tenants/'
-
-  def self.ios_profiles
-    issue_request(:get, full_url('/iosprofiles'), {})
-  end
-
-  def self.device_profile_list(device_id)
-    issue_request(:get, full_url("/devices/#{ device_id }/profiles"), {})
-  end
-
-  def self.tenant_managed_app_list
-    issue_request(:get, full_url('/iosmanagedapps'), {})
-  end
-
-  def self.device_managed_app_list(device_id)
-    issue_request(:get, full_url("/devices/#{ device_id }/managedapps"), {})
-  end
-
-  def self.perform_action(device_id, body_hash)
-    issue_request(:put, full_url("/devices/#{ device_id }/actions"), body_hash)
-  end
-
-  def self.action(device_id, action_id)
-    issue_request(:get, full_url("/devices/#{ device_id }/actions/#{ action_id }"), {})
-  end
-
-  def self.full_url(path)
-    raise "No Moki URL Provided. Set ENV['MOKI_API_URL']."    if ENV['MOKI_API_URL'].nil? || ENV['MOKI_API_URL'].empty?
-    raise "No Tenant ID Provided. Set ENV['MOKI_TENANT_ID']." if ENV['MOKI_TENANT_ID'].nil? || ENV['MOKI_TENANT_ID'].empty?
-
-    ENV['MOKI_API_URL'] + BASE_URL + ENV['MOKI_TENANT_ID'] + path
-  end
-
-  def self.issue_request(method, url, options)
-    raise "No API Key Provided. Set ENV['MOKI_API_KEY']."     if ENV['MOKI_API_KEY'].nil? || ENV['MOKI_API_KEY'].empty?
-
-    future = Celluloid::Future.new do
-      begin
-        log_request(method, url)
-        response = conn.send(method, url, options) do |request|
-          request.headers = request.headers.merge(headers)
-        end
-        to_return_type response
-      rescue => e
-        Honeybadger.notify(e, context: { method: method,
-                                         url: url,
-                                         options: options,
-                                         response_status: response.try(:status),
-                                         response_body: response.try(:body) }) if defined?(Honeybadger)
-        raise e
-      end
-    end
-    future.extend(FutureWrapper)
-  end
-
-  def issue_request(method, url, options)
-    self.class.issue_request(method, url, options)
-  end
-
-private
-  def self.to_return_type response
-    begin
-      Hashie::Mash.new({
-        body: JSON.parse(response.body),
-        status: response.status,
-        headers: response.headers
-      })
-    rescue
-      response
-    end
-  end
-
-  def self.conn
-    connection = Faraday.new do |conn|
-      conn.request :json
-      conn.adapter Faraday.default_adapter
-    end
-    connection
-  end
-
-  def self.headers
-    {
-      "X-Moki-TenantAPIToken" => ENV['MOKI_API_KEY']
-    }
-  end
-
-  def self.log_request(method, url)
-    logger = if defined?(Rails)
-               Rails.logger
-             elsif defined?(Napa::Logger)
-               Napa::Logger.logger
-             else
-               nil
-             end
-
-    return unless logger
-
-    data = { moki_api_request:
-      {
-        message: "Calling Moki API URL #{ url }",
-        request_method: method,
-        request_url: url,
-      }
-    }
-
-    logger.info(data.as_json)
-  end
-end