airwatch-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 775aafdbb0a361df1e1dc3bc638216df732dfd2480df69aeb8ec1c857ab66478
+  data.tar.gz: 02fd6ebbfe64d3f5d46af4ba35ac3f00e8130c9ff767a3af39320b2ac0dd94a5
+SHA512:
+  metadata.gz: f995fd58984c6075c09d8329b38fb670b37101b623d0ca3b6131f6fcf7f07d924b906559b56ac06f64beb8faeec5a2d5c2be12229d5e2a2ef62dd88f47dada1a
+  data.tar.gz: f23677fb66ca59e8da832a07ab4b5225f96b5dc391cebd08800a4091935c671eb1ea8e9183ea035410d7293241f52279e341a1cf523a5ebe8562401575209ea9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at daveschukin@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in airwatch-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    airwatch-ruby (0.1.0)
+      addressable (~> 2.7.0)
+      httparty (~> 0.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    diff-lcs (1.4.4)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    io-console (0.5.6)
+    irb (1.2.4)
+      reline (>= 0.0.1)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    multi_xml (0.6.0)
+    public_suffix (4.0.5)
+    rake (10.5.0)
+    reline (0.1.4)
+      io-console (~> 0.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  airwatch-ruby!
+  bundler (~> 1.17)
+  irb
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2020 Observant
+
+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,3 @@
+# airwatch-ruby
+
+TODO: make a readme

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/airwatch-ruby.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "airwatch/ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "airwatch-ruby"
+  spec.version       = Airwatch::Ruby::VERSION
+  spec.authors       = ["Dave Schukin"]
+  spec.email         = ["daveschukin@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper around AirWatch REST API}
+  spec.description   = %q{Ruby wrapper around AirWatch REST API.}
+  spec.homepage      = "https://www.github.com/observantlabs/airwatch-ruby"
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency 'httparty', '~> 0.18'
+  spec.add_runtime_dependency 'addressable', '~> 2.7.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "airwatch/ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/airwatch.rb

@@ -0,0 +1,4 @@
+require 'airwatch/client'
+
+module Airwatch
+end

data/lib/airwatch/client.rb

@@ -0,0 +1,178 @@
+module Airwatch
+  class Client
+  	# @param [String] host make sure you get this from Settings > System > Advanced > Site URLs
+	def initialize(host_name, api_key, email: nil, password: nil, authorization: nil)
+		@host_name = host_name
+		@api_key = api_key
+
+		if email && password
+			@authorization = "Basic #{Base64.strict_encode64("#{email}:#{password}")}"
+		elsif authorization
+			@authorization = authorization
+		else
+			raise 'must provide (email & password) or authorization'
+		end
+	end
+
+	#############################
+	# Apps      				#
+	#############################
+
+	# @param [String] (optional) bundleid the app's bundle identifier, or nil
+	# @param [String] (optional) type 'app' or nill
+	# @param [String] (optional) applicationtype 'internal' or nil
+	def apps_search(**args)
+		params = args.to_h
+		get('mam/apps/search', params)
+	end
+
+	# returns a list of device IDs that the app is installed on
+	def app_devices(app_id)
+		get("mam/apps/internal/#{app_id}/devices")
+	end
+
+	def install_internal_app(app_id, device_id)
+		post("mam/apps/internal/#{app_id}/install", { deviceid: device_id })
+	end
+
+	#############################
+	# Profiles  				#
+	#############################
+
+	# @see page 722 of AirWatch REST API docs
+	def profiles_platforms_apple_create
+	end
+
+	# @see page 1034 of AirWatch REST API docs
+	# @param [String] profile_id the AirWatch profile ID
+	# @param [Integer] device_id the AirWatch device ID
+	#
+	# This method is idempotent.
+	def profiles_install(profile_id, device_id: nil, serial_number: nil)
+		params = {}
+
+		unless device_id.nil?
+			params[:deviceid] = device_id
+		end
+
+		unless serial_number.nil?
+			params[:serialnumber] = serial_number
+		end
+
+		post("mdm/profiles/#{profile_id}/install", params)
+	end
+
+	# @see page 1034 of AirWatch REST API docs
+	# @param [String] profile_id the AirWatch profile ID
+	# @param [Integer] device_id the AirWatch device ID
+	#
+	# This method is NOT idempotent; after the first successful call, subsequent calls will return HTTP 400. 
+	def profiles_remove(profile_id, device_id)
+		post("mdm/profiles/#{profile_id}/remove", { deviceid: device_id })
+	end
+
+	#############################
+	# Smart groups 				#
+	#############################
+
+	def smart_groups_search
+		get('mdm/smartgroups/search')
+	end
+
+	# @see page 1173 of AirWatch REST API docs
+	#
+	# returns the list of apps assigned to Smart Group.
+	def smart_group_apps(smart_group_id)
+		get("mdm/smartgroups/#{smart_group_id}/apps")
+	end
+
+	def smart_group_details(smart_group_id)
+		get("mdm/smartgroups/#{smart_group_id}")
+	end
+
+	#############################
+	# Devices           		#
+	#############################
+
+	def device_details(device_id)
+		get("mdm/devices/#{device_id}")
+	end
+
+	def device_profile_details(device_id: nil, serial_number: nil)
+		params = {}
+
+		unless device_id.nil?
+			params[:searchby] = 'deviceid'
+			params[:id] = device_id
+		end
+
+		unless serial_number.nil?
+			params[:searchby] = 'serialnumber'
+			params[:id] = serial_number
+		end
+
+		get('mdm/devices/profiles', params)
+	end
+
+	#############################
+	# HTTP request stuff		#
+	#############################
+
+	def get(resource, params = {})
+		url = build_url(resource, params)
+		HTTParty.get(url, { headers: request_headers })
+	end
+
+	def put(resource, params = {})
+		url = build_url(resource)
+		HTTParty.put(url, { headers: request_headers, body: params })
+	end
+
+	def post(resource, params = {})
+		url = build_url(resource)
+		HTTParty.post(url, { headers: request_headers, body: params })
+	end
+
+	def pretty_get(resource, params = {})
+		response = get(resource, params)
+		unless response.code == 200
+			puts response
+			puts "⚠️  HTTP #{response.code}"
+			return
+		end
+		puts JSON.pretty_generate(response.parsed_response)
+	end
+
+	def upload_blob(file_path, org_group_id)
+		raise "No IPA found at path: #{file_path}" unless File.file?(file_path)
+		filename = File.basename(file_path)
+		url = build_url('mam/blobs/uploadblob', { filename: filename, organizationgroupid: org_group_id })
+		payload = File.open(file_path, 'rb')
+		headers = request_headers
+		headers[:'Content-Type'] = 'application/octet-stream'
+		headers[:'Expect'] = '100-continue'
+		response = RestClient::Request.execute(
+			:url => url,
+			:method => :post,
+			:headers => headers,
+			:payload => File.open(file_path, 'rb')
+		)
+	end
+
+	# private
+	def request_headers
+		{
+			'aw-tenant-code': @api_key,
+			'Accept': 'application/json',
+			'Authorization': @authorization
+		}
+	end
+
+	def build_url(resource, query_params = nil)
+		url = "https://#{@host_name}/api/#{resource}"
+		return url if query_params.nil?
+		template = Addressable::Template.new("#{url}{?query*}")
+		template.expand(query: query_params).to_s
+	end
+  end
+end

data/lib/airwatch/ruby.rb

@@ -0,0 +1,8 @@
+require "airwatch/ruby/version"
+
+module Airwatch
+  module Ruby
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/airwatch/ruby/version.rb

@@ -0,0 +1,5 @@
+module Airwatch
+  module Ruby
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: airwatch-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Schukin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+description: Ruby wrapper around AirWatch REST API.
+email:
+- daveschukin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- airwatch-ruby.gemspec
+- bin/console
+- bin/setup
+- lib/airwatch.rb
+- lib/airwatch/client.rb
+- lib/airwatch/ruby.rb
+- lib/airwatch/ruby/version.rb
+homepage: https://www.github.com/observantlabs/airwatch-ruby
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper around AirWatch REST API
+test_files: []