limelm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f7bfe43b8147336288dec12ddb8cd5518ebaede
+  data.tar.gz: ef7e67debc9162ee42338bd63979ae74fd736b6e
+SHA512:
+  metadata.gz: 2abe2f632746d8153cc5f8a26bb60204335f564bba62d77287e1aa55e63331c193f53b6dea5dd63929e3a6f8b8cfb209dab3a8d7d3181a8ace16b67a9f2f0f8a
+  data.tar.gz: f49186894b96e139e7145231c0ed29903cca69cff37996fc1d8276306df809e1f3d454d571158f26192774f6d4d024826d21599c82b48aa00278b06411d9816c

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem 'httparty'
+
+group :development do
+  gem 'rdoc'
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler', '~> 2.0.1'
+end
+
+group :test do 
+  gem 'webmock'
+  gem 'vcr'
+  gem 'simplecov', require: false 
+end

data/Gemfile.lock

@@ -0,0 +1,75 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.7)
+    builder (3.2.2)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.4.0)
+    highline (1.7.1)
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.2)
+    jwt (1.3.0)
+    mini_portile (0.6.2)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.0)
+    rake (10.4.2)
+    rdoc (4.1.0)
+    safe_yaml (1.0.4)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    thread_safe (0.3.4)
+    vcr (2.9.3)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  httparty
+  jeweler (~> 2.0.1)
+  rdoc
+  simplecov
+  vcr
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Damien Imberdis
+
+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,75 @@
+# limelm
+
+A Ruby API wrapper for the LimeLM API. LimeLM is a powerfull Licence and Online Activation Manager. For more information, see: http://wyday.com/limelm/
+
+Documentation for the LimeLM API can be found here: https://wyday.com/limelm/help/api/
+
+## Setup
+
+	gem install limelm
+
+Or with bundler,
+
+```ruby
+gem "limelm"
+```	
+
+Before using the library, you must initialize it with your LimeLM API key. If you're using Rails, put this code in an initializer:
+
+```ruby
+LimeLm.configure(api_key: 'YOUR_API_KEY')
+```
+
+If you are working with an unique version of a Product, you can set it during the configuration: 
+
+```ruby
+LimeLm.configure(api_key: 'YOUR_API_KEY', version_id: 'YOUR_PRODUCT_VERSION_ID')
+```
+
+## Usage example
+
+Find all the keys that matching a specific product version (cf. version_id parameter) and a specific user via its registered email:
+
+```ruby 
+LimeLm::Key.find('imberdis.damien@gmail.com', version_id: '1')
+```
+
+## API endpoints not developed yet
+* [deactivate a specific activation](https://wyday.com/limelm/help/api/limelm.pkey.deactivate/)
+* [manual offline activation of a key](https://wyday.com/limelm/help/api/limelm.pkey.manualActivation/)
+* [manual offline deactivation of a key](https://wyday.com/limelm/help/api/limelm.pkey.manualDeactivation/)
+* [trial extension CRUD operation](https://wyday.com/limelm/help/api/)
+* [Gets the activity of a product version between a date range](https://wyday.com/limelm/help/api/limelm.pkey.activity/)
+* [Remove a tag from all product keys](https://wyday.com/limelm/help/api/limelm.tag.delete/)
+
+## Contribute to limelm
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+### Testing
+
+All tests can be run by the command `rake spec`. By default, all the API requests are mocked by web fixtures. 
+
+As LimeLM not providing yet a demo environment, you will need to use your own product version to implement new functionalities:
+
+* create a conf.yml file under the project root directory that will containes your personal `api_ key` and `version_id`.
+* nether share that file via your source control tool.
+* write new test (cf. other tests as examples on how to use VCR for mocking the HTTP requests), launch them with the command `rake spec MODE=live`.
+* Once VCR generated the fixtures, anonymize them (replace every api_key, version_id, key ids and values by fake data).
+
+
+## Disclaimer
+
+This project and the code therein was not created by and is not supported by WyDay, Inc or any of its affiliates.
+
+## Copyright
+
+Copyright (c) 2015 Damien Imberdis. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "limelm"
+  gem.homepage = "http://github.com/dam/limelm"
+  gem.license = "MIT"
+  gem.summary = %Q{limelm is a Ruby wrapper for the LimeLM JSON API}
+  gem.description = %Q{limelm is a Ruby wrapper for the LimeLM JSON API. LimeLM is a powerfull Licence and Online Activation Manager}
+  gem.email = "imberdis.damien@gmail.com"
+  gem.authors = ["Damien Imberdis"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "limelm #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO.md

@@ -0,0 +1,10 @@
+# API endpoints not yet implemented
+* [deactivate a specific activation](https://wyday.com/limelm/help/api/limelm.pkey.deactivate/)
+* [manual offline activation of a key](https://wyday.com/limelm/help/api/limelm.pkey.manualActivation/)
+* [manual offline deactivation of a key](https://wyday.com/limelm/help/api/limelm.pkey.manualDeactivation/)
+* [trial extension CRUD operation](https://wyday.com/limelm/help/api/)
+* [Gets the activity of a product version between a date range](https://wyday.com/limelm/help/api/limelm.pkey.activity/)
+* [Remove a tag from all product keys](https://wyday.com/limelm/help/api/limelm.tag.delete/)
+
+# Tests
+* LimeLm::Key.search: add more tests to cover some optional parameters 

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/lime_lm/connection.rb

@@ -0,0 +1,23 @@
+module LimeLm
+  class Connection
+    include HTTParty
+    base_uri 'https://wyday.com/limelm/api/rest/'
+
+    class << self
+      def post_json(params)
+        raise LimeLm::InvalidParams, 'LimeLM api expecting a method parameter' unless params[:method]
+  	  	
+        params[:api_key] = LimeLm.config[:api_key]
+        params[:format] = :json
+
+        response = post('', query: params)
+
+        parsed_response = JSON.parse($1) if response.body =~ /jsonLimeLMApi\((.*)\)/
+        raise LimeLm::ParseResponse, "Unable to parse API response: #{response.body }" unless parsed_response
+  	    
+        raise LimeLm::ApiError, "#{parsed_response['code']}: #{parsed_response['message']}" unless parsed_response['stat'] == 'ok'
+        parsed_response
+      end	
+    end
+  end
+end

data/lib/lime_lm/exceptions.rb

@@ -0,0 +1,6 @@
+module LimeLm
+  class InvalidParams < StandardError; end
+  class ParseResponse < StandardError; end
+  class ApiError < StandardError; end
+  class InvalidObject < StandardError; end
+end

data/lib/lime_lm/feature.rb

@@ -0,0 +1,62 @@
+module LimeLm
+  class Feature
+    attr_reader :id
+    attr_reader :name
+    attr_reader :type
+    attr_reader :ta_readable
+    attr_reader :required
+    attr_reader :description  	
+
+    def initialize(hash)
+      self.send(:assign_properties, hash)
+    end
+
+    class << self
+      def create(params={})
+        version_id = params.delete(:version_id) { LimeLm.config[:version_id] }
+
+        response = LimeLm::Connection.post_json({ method: 'limelm.feature.add', version_id: version_id }.merge!(params))
+        additional_info = LimeLm::Utils.stringify_keys(params)
+        additional_info['type'] = 'string' unless additional_info['type'] 
+        additional_info['required'] = 'true' unless additional_info['required']
+        additional_info['ta_readable'] = 'true' unless additional_info['ta_readable']
+
+        new(response['feature'].merge!(additional_info))
+      end
+
+      def all(params={})
+      	version_id = params.delete(:version_id) { LimeLm.config[:version_id] }
+        
+        response = LimeLm::Connection.post_json({ method: 'limelm.feature.getAll', version_id: version_id })
+        response['fields']['field'].map { |f| new(f) }
+      end
+    end
+
+    def update!(params={})
+      response = LimeLm::Connection.post_json({ method: 'limelm.feature.edit', feature_id: @id }.merge!(params))
+      new_info = LimeLm::Utils.stringify_keys(params)
+      @name        = new_info['name'] if new_info['name']
+      @ta_readable = (new_info['ta_readable'] == 'true') if new_info['ta_readable']
+      @required    = (new_info['required'] == 'true') if new_info['required']
+      @description = new_info['description'] if new_info['description']
+      true
+    end
+
+    def destroy!
+      LimeLm::Connection.post_json({ method: 'limelm.feature.delete', feature_id: @id })
+      true
+    end
+
+    private
+
+    def assign_properties(hash)
+      hash         = LimeLm::Utils.stringify_keys(hash)
+      @id          = hash['id']
+      @name        = hash['name']
+      @type        = hash['type']
+      @ta_readable = hash['ta_readable'] == 'true'
+      @required    = hash['required'] == 'true'
+      @description = hash['description']
+    end
+  end
+end

data/lib/lime_lm/key.rb

@@ -0,0 +1,83 @@
+module LimeLm
+  class Key
+    attr_reader :id
+    attr_reader :key
+    attr_reader :version_id
+    attr_reader :email
+    attr_reader :revoked
+    attr_reader :properties  	
+
+    def initialize(hash)
+      self.send(:assign_properties, hash)
+      raise LimeLm::InvalidObject, 'You need to provide at least an id or a key for the LimeLm::Key object' unless @id || @key
+    end
+
+    class << self
+      def create(params={})
+        version_id = params.delete(:version_id) { LimeLm.config[:version_id] }
+
+        response = LimeLm::Connection.post_json({ method: 'limelm.pkey.generate', version_id: version_id }.merge!(params))
+        additional_info = LimeLm::Utils.stringify_keys(params.merge!({ version_id: version_id }))
+        response['pkeys']['pkey'].map { |k| new(k.merge!(additional_info)) }
+      end
+
+      def find(email, params={})
+      	version_id = params.delete(:version_id) { LimeLm.config[:version_id] }
+
+      	response = LimeLm::Connection.post_json({ method: 'limelm.pkey.find', version_id: version_id, email: email })
+        response['pkeys']['pkey'].map { |k| new(k.merge!({ 'version_id' => version_id, 'email' => email })) } 
+      end
+
+      def search(params={})
+        response = LimeLm::Connection.post_json({ method: 'limelm.pkey.advancedSearch'}.merge!(params))
+        response['pkeys']['pkey'].map { |k| new(k) }
+      end
+    end
+
+    def id(params={})
+      return @id if @id
+      
+      version_id = params.delete(:version_id) { LimeLm.config[:version_id] }
+      response = LimeLm::Connection.post_json({ method: 'limelm.pkey.getID', version_id: version_id, pkey: @key })
+      @id = response['pkey']['id']
+    end
+
+    def tag(tags=[])
+      LimeLm::Connection.post_json({ method: 'limelm.pkey.setTags', pkey_id: @id, tag: tags })
+      true
+    end 
+    
+    def remove_tag(tag)
+      LimeLm::Connection.post_json({ method: 'limelm.pkey.removeTag', pkey_id: @id, tag: tag })
+      true
+    end
+
+    def details
+      response = LimeLm::Connection.post_json({ method: 'limelm.pkey.getDetails', pkey_id: @id })
+      self.send(:assign_properties, response['pkey'])
+    end
+
+    def destroy!
+      LimeLm::Connection.post_json({ method: 'limelm.pkey.delete', pkey_id: @id })
+      true
+    end
+
+    def toggle_revoke!
+      revoke = @revoked ? 'false' : 'true'
+      LimeLm::Connection.post_json({ method: 'limelm.pkey.revoke', pkey_id: @id, revoke: revoke })
+      @revoked = !@revoked
+    end
+
+    private
+
+    def assign_properties(hash)
+      hash        = LimeLm::Utils.stringify_keys(hash)
+      @id         = hash['id']
+      @key        = hash['key']
+      @version_id = hash['version_id']
+      @email      = hash['email']
+      @revoked    = hash['revoked'] || false
+      @properties = hash
+    end
+  end
+end