dev_mate 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22cc40a360fbea2102ff8b9f687c3592a99ef577
+  data.tar.gz: 3d0294a9294237de307e027248b242d14a1f7d9e
+SHA512:
+  metadata.gz: 75ab45fadf9069a94d26974e1fa221ae22b44b1cdbf4e6f61d3854be3e128ce90d55d175d9eeed253f35811fe60b01aeb97a6f49515c0e850dc8d804664e866f
+  data.tar.gz: faaf595fae80fc4e7f1744d08d26e04d4c9992137c3b0d1bce1f1982a40cef92290326bd74c0254582f795d45f8ac3c6073ff67385203634e5d822cacb65fe1b

data/.gitignore

@@ -0,0 +1,11 @@
+/.idea
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at don@slack-corp.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Don Goodman-Wilson
+
+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,81 @@
+# dev_mate
+[![Build Status](https://travis-ci.org/DEGoodmanWilson/ruby-devmate.svg?branch=master)](https://travis-ci.org/DEGoodmanWilson/ruby-devmate)
+[![Coverage Status](https://coveralls.io/repos/github/DEGoodmanWilson/ruby-devmate/badge.svg?branch=master)](https://coveralls.io/github/DEGoodmanWilson/ruby-devmate?branch=master)
+
+You use [DevMate](http://devmate.com) for selling your OS X apps, and your back-end is written in Ruby. This is the gem for you :D
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dev_mate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dev_mate
+
+## Usage
+
+The DevMate API is centered on Customer objects. A customer represents, yes you guessed it, one of your customers. NB: No two customers may share the same email address.
+
+To start working with the DevMate API, you'll need to (of course) create an account, and register your application. You will also need an API key, available from your [DevMate Dashboard](https://dashboard.devmate.com) under Company Settings > API Integration
+
+### Setting your API Token
+```ruby
+DevMate::DevMate.SetToken('foobar')
+```
+
+### Creating a new customer object
+```ruby
+customer = DevMate::DevMate.CreateCustomer( { "email" => "foo@example.com", "first_name" => "Jon", "last_name" => "Snow" } )
+```
+
+
+
+### Updating an existing customer object
+```ruby
+customer["last_name"] = "Stark"
+DevMate::DevMate.UpdateCustomer(customer)
+```
+
+### Finding a customer by Id
+```ruby
+customer = DevMate::DevMate.FindCustomerById(42)
+```
+
+### Searching for customers by email address or name
+```ruby
+customerListWithEmail = DevMate::DevMate.FindCustomerWithFilters(email: "foo@example.com")
+
+customerListWithName = DevMate::DevMate.FindCustomerWithFilters(last_name: "Snow")
+```
+
+### Creating a license key for a customer
+
+(You'll need to know the Id of the license type that you want to create)
+
+```ruby
+license = DevMate::DevMate.CreateLicense(customer, 1)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DEGoodmanWilson/dev_mate. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dev_mate"
+
+# 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

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/dev_mate.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dev_mate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dev_mate"
+  spec.version       = DevMate::VERSION
+  spec.authors       = ["D.E. Goodman-Wilson"]
+  spec.email         = ["degoodmanwilson@gmail.com"]
+
+  spec.summary       = %q{An SDK for accessing the dev_mate API.}
+  spec.description   = %q{Are you building an OS X app using dev_mate? Need to integrate the dev_mate API into your license server backend? Then this is the gem for you.}
+  spec.homepage      = "https://github.com/DEGoodmanWilson/ruby-devmate"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", "~> 0.13"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.9"
+  spec.add_development_dependency "coveralls"
+end

data/lib/dev_mate.rb

@@ -0,0 +1,208 @@
+require "dev_mate/version"
+require "json"
+require "httparty"
+
+module DevMate
+
+  class BadRequestError < StandardError
+  end
+
+  class UnauthorizedError < StandardError
+  end
+
+  class ConflictError < StandardError
+  end
+
+  class NotFoundError < StandardError
+  end
+
+  class UnknownError < StandardError
+  end
+
+  class DevMate
+    include HTTParty
+
+    base_uri 'https://public-api.devmate.com/v2'
+
+    def self.SetToken(token)
+      @@token = token
+      @@auth_header = "Token #{token}"
+    end
+
+    def self.Token
+      @@token
+    end
+
+    def self.CreateCustomer(email, last_name: nil, first_name: nil, note: nil)
+      data = { :email => email }
+      data[last_name] = last_name if last_name
+      data[first_name] = first_name if first_name
+      data[note] = note if note
+      body = { :data => data }
+
+      raise UnauthorizedError, "Please specify a token with SetToken()" unless defined? @@token
+
+      options = { :body => body.to_json, :headers => { "Authorization" => @@auth_header } }
+      response = self.post('/customers/', options)
+
+      #TODO handle timeouts!
+      response_object = JSON.parse response.body
+
+      unless response.code == 201
+        #sad path
+        errors = response_object["errors"]
+
+        case response.code
+          when 400
+            raise BadRequestError, "#{errors[0]["title"]} #{errors[0]["detail"]}"
+          when 401
+            raise UnauthorizedError, errors[0]["title"]
+          when 409
+            raise ConflictError, "#{errors[0]["title"]} #{errors[0]["detail"]}"
+          else
+            raise UnknownError
+        end
+      end
+
+      # return response.body on success
+      response_object = JSON.parse response.body
+      return response_object['data']
+    end
+
+    def self.FindCustomerById(id)
+
+      raise UnauthorizedError, "Please specify a token with SetToken()" unless defined? @@token
+
+      response = self.get("/customers/#{id}", :headers => { "Authorization" => @@auth_header })
+
+      #TODO handle timeouts!
+      response_object = JSON.parse response.body
+
+      unless response.code == 201
+        #sad path
+        errors = response_object["errors"]
+
+        case response.code
+          when 401
+            raise UnauthorizedError, errors[0]["title"]
+          when 404
+            return nil
+        end
+      end
+
+      # return response.body on success
+      response_object = JSON.parse response.body
+      return response_object['data']
+    end
+
+    def self.FindCustomerWithFilters(email: nil, first_name: nil, last_name: nil, license_key: nil, identifier: nil, order_id: nil, activation_id: nil, invoice: nil, offset: nil, limit: nil, with: nil)
+
+      query = {}
+      query["filter[email]"] = email if email
+      query["filter[first_name]"] = first_name if first_name
+      query["filter[last_name]"] = last_name if last_name
+      query["filter[license_key]"] = license_key if license_key
+      query["filter[identifier]"] = identifier if identifier
+      query["filter[order_id]"] = order_id if order_id
+      query["filter[activation_id]"] = activation_id if activation_id
+      query["filter[invoice]"] = invoice if invoice
+      query["offset"] = offset if offset
+      query["limit"] = limit if limit
+      query["with"] = with if with
+
+      raise UnauthorizedError, "Please specify a token with SetToken()" unless defined? @@token
+
+      response = self.get("/customers", :query => query, :headers => { "Authorization" => @@auth_header })
+
+      #TODO handle timeouts!
+      response_object = JSON.parse response.body
+
+      unless response.code == 201
+        #sad path
+        errors = response_object["errors"]
+
+        case response.code
+          when 401
+            raise UnauthorizedError, errors[0]["title"]
+          when 404
+            return []
+        end
+      end
+
+      # return response.body on success
+      response_object = JSON.parse response.body
+      return response_object['data']
+    end
+
+    def self.UpdateCustomer(customer)
+
+      return nil unless customer['id']
+
+      id = customer['id']
+
+      new_customer = {}
+      new_customer[:email] = customer["email"] if customer["email"]
+      new_customer[:first_name] = customer["first_name"] if customer["first_name"]
+      new_customer[:last_name] = customer["last_name"] if customer["last_name"]
+      new_customer[:notes] = customer["notes"] if customer["notes"]
+
+      data = { :data => new_customer }
+
+      raise UnauthorizedError, "Please specify a token with SetToken()" unless defined? @@token
+
+      response = self.put("/customers/#{id}", :body => data.to_json, :headers => { "Authorization" => @@auth_header })
+
+      #TODO handle timeouts!
+      response_object = JSON.parse response.body
+
+      unless response.code == 201
+        #sad path
+        errors = response_object["errors"]
+
+        case response.code
+          when 400
+            raise BadRequestError, "#{errors[0]["title"]} #{errors[0]["detail"]}"
+          when 401
+            raise UnauthorizedError, errors[0]["title"]
+          when 404
+            raise NotFoundError, "#{errors[0]["title"]} #{errors[0]["detail"]}"
+          when 409
+            raise ConflictError, "#{errors[0]["title"]} #{errors[0]["detail"]}"
+        end
+      end
+
+      # return response.body on success
+      response_object = JSON.parse response.body
+      return response_object['data']
+    end
+
+    def self.CreateLicense(customer, licenseId)
+      id = customer["id"]
+      data = { :data => { :license_type_id => licenseId } }
+
+      raise UnauthorizedError, "Please specify a token with SetToken()" unless defined? @@token
+
+      response = self.post("/customers/#{id}/licenses", :body => data.to_json, :headers => { "Authorization" => @@auth_header })
+
+      #TODO handle timeouts!
+      response_object = JSON.parse response.body
+
+      unless response.code == 201
+        #sad path
+        errors = response_object["errors"]
+
+        case response.code
+          when 400
+            raise BadRequestError, "#{errors[0]["title"]} #{errors[0]["detail"]}"
+          when 401
+            raise UnauthorizedError, errors[0]["title"]
+        end
+      end
+
+      # return response.body on success
+      response_object = JSON.parse response.body
+      return response_object['data']
+    end
+
+  end # class
+end # module

data/lib/dev_mate/version.rb

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

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: dev_mate
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- D.E. Goodman-Wilson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: Are you building an OS X app using dev_mate? Need to integrate the dev_mate
+  API into your license server backend? Then this is the gem for you.
+email:
+- degoodmanwilson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dev_mate.gemspec
+- lib/dev_mate.rb
+- lib/dev_mate/version.rb
+homepage: https://github.com/DEGoodmanWilson/ruby-devmate
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: An SDK for accessing the dev_mate API.
+test_files: []