Project

dev_mate

0.0
No commit activity in last 3 years
No release in over 3 years
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.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.7
~> 5.9
~> 10.0

Runtime

~> 0.13
 Project Readme

dev_mate

Build Status Coverage Status Gem Version

You use DevMate 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:

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 under Company Settings > API Integration

Setting your API Token

DevMate::DevMate.SetToken('foobar')

Creating a new customer object

customer = DevMate::DevMate.CreateCustomer( { "email" => "foo@example.com", "first_name" => "Jon", "last_name" => "Snow" } )

Updating an existing customer object

customer["last_name"] = "Stark"
DevMate::DevMate.UpdateCustomer(customer)

Finding a customer by Id

customer = DevMate::DevMate.FindCustomerById(42)

Searching for customers by email address or name

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)

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.

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 code of conduct.

License

The gem is available as open source under the terms of the MIT License.