limelm 0.1.0

data/spec/fixtures/dish_cassettes/revoke_key.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://wyday.com/limelm/api/rest?api_key=new_key_from_yaml&format=json&method=limelm.pkey.revoke&pkey_id=1&revoke=true
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 02 Mar 2015 17:17:35 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - PHPSESSID=4cp2glbm9k5eiauq3cjhgj7s25; path=/
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Frame-Options:
+      - SAMEORIGIN
+    body:
+      encoding: UTF-8
+      string: jsonLimeLMApi({"stat":"ok"})
+    http_version: 
+  recorded_at: Mon, 02 Mar 2015 17:17:35 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/dish_cassettes/set_tags_for_a_given_key.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://wyday.com/limelm/api/rest?api_key=new_key_from_yaml&format=json&method=limelm.pkey.setTags&pkey_id=1&tag%5B%5D=demo&tag%5B%5D=enterprise
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Fri, 27 Feb 2015 15:13:17 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - PHPSESSID=6tif4d0nffmfevep96tp5m9r71; path=/
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Frame-Options:
+      - SAMEORIGIN
+    body:
+      encoding: UTF-8
+      string: jsonLimeLMApi({"stat":"ok"})
+    http_version: 
+  recorded_at: Fri, 27 Feb 2015 15:13:17 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/dish_cassettes/unrevoke_key.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://wyday.com/limelm/api/rest?api_key=new_key_from_yaml&format=json&method=limelm.pkey.revoke&pkey_id=1&revoke=false
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 02 Mar 2015 17:26:17 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - PHPSESSID=qe3dcp1vg20ev73mn249ci0d02; path=/
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Frame-Options:
+      - SAMEORIGIN
+    body:
+      encoding: UTF-8
+      string: jsonLimeLMApi({"stat":"ok"})
+    http_version: 
+  recorded_at: Mon, 02 Mar 2015 17:26:17 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/dish_cassettes/update_custom_feature.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://wyday.com/limelm/api/rest?api_key=new_key_from_yaml&description=updated_description&feature_id=3&format=json&method=limelm.feature.edit&name=updated_name&required=true&ta_readable=false
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 03 Mar 2015 20:45:39 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - PHPSESSID=91fqd0ks6jjcp7ohq7lem5vr45; path=/
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Frame-Options:
+      - SAMEORIGIN
+    body:
+      encoding: UTF-8
+      string: jsonLimeLMApi({"stat":"ok"})
+    http_version: 
+  recorded_at: Tue, 03 Mar 2015 20:45:39 GMT
+recorded_with: VCR 2.9.3

data/spec/lib/lime_lm/feature_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe LimeLm::Feature do
+  describe '#initialize' do 
+    it 'sets default object attributes' do 
+      feature = LimeLm::Feature.new({
+      	'id'          => '1', 
+      	'name'        => 'updates_expires', 
+      	'type'        => 'date_time',
+        'ta_readable' => 'true', 
+        'required'    => 'false', 
+        'description' => "Date when the license key expires."
+      })
+      assert_equal '1', feature.id
+      assert_equal 'updates_expires', feature.name
+      assert_equal 'date_time', feature.type
+      assert feature.ta_readable
+      assert !feature.required
+      assert !feature.description.empty?
+    end
+  end
+
+  describe '.all' do 
+    it 'returns all the custom license fields for a given product version' do 
+      VCR.use_cassette("all_features", match_requests_on: [:path]) do
+        result = LimeLm::Feature.all(version_id: '2')
+        assert_equal 1, result.count
+        feature = result.first
+        assert_instance_of LimeLm::Feature, feature
+      end
+    end
+  end 
+
+  describe '.create' do 
+    it 'creates a new product custom license field with a name by default' do
+      VCR.use_cassette("create_product_default_feature", match_requests_on: [:path]) do
+        new_feature_name = 'plan'
+        result = LimeLm::Feature.create(name: new_feature_name)
+        assert_instance_of LimeLm::Feature, result
+        assert_equal '2', result.id
+        assert_equal 'string', result.type
+        assert result.required, 'required by default'
+        assert result.ta_readable, 'readable by default'
+      end  
+    end
+
+    it 'accepts more specified options' do 
+      VCR.use_cassette("create_custom_feature", match_requests_on: [:path]) do
+        result = LimeLm::Feature.create(name: 'customized_plan', type: 'int', required: 'false',
+          ta_readable: 'false', description: 'new customized field')
+        assert_equal '3', result.id
+        assert_equal 'customized_plan', result.name
+        assert_equal 'int', result.type
+        assert_equal 'new customized field', result.description
+        assert !result.required
+        assert !result.ta_readable
+      end
+    end
+  end 
+
+  describe '#update!' do 
+    it 'updates features properties and returns true in case of success' do 
+      VCR.use_cassette("update_custom_feature", match_requests_on: [:path]) do
+        feature = LimeLm::Feature.new(id: '3')
+        result = feature.update!(name: 'updated_name', required: 'true',
+          ta_readable: 'false', description: 'updated_description')
+        
+        assert feature, 'Returns true if update succeed'
+        assert_equal '3', feature.id
+        assert_equal 'updated_name', feature.name
+        assert_equal 'updated_description', feature.description
+        assert feature.required
+        assert !feature.ta_readable  
+      end
+    end
+  end
+
+  describe '#destroy!' do 
+    it 'returns true if the feature has been destroyed' do 
+      VCR.use_cassette("destroy_feature", match_requests_on: [:path]) do
+        feature = LimeLm::Feature.new(id: '3')
+        assert feature.destroy!, 'Destroy should work'
+      end
+    end  
+  end
+end

data/spec/lib/lime_lm/key_spec.rb

@@ -0,0 +1,212 @@
+require 'spec_helper'
+
+describe LimeLm::Key do
+  describe '#initialize' do 
+    it 'raises an error if no id and no product key specified during Object creation' do 
+      assert_raises(LimeLm::InvalidObject) { LimeLm::Key.new({}) }
+      LimeLm::Key.new({ 'id' => '1' })
+      LimeLm::Key.new({ 'key' => 'AAAA-BBBB' })
+    end
+
+    it 'sets default object attributes' do 
+      key = LimeLm::Key.new({ 'id' => '1', 'key' => 'AAA-BBB', 'version_id' => '1',
+        'email' => 'imberdis.damien@gmail.com' })
+      assert_equal 'imberdis.damien@gmail.com', key.email
+      assert_equal 'AAA-BBB', key.key
+      assert_equal '1', key.version_id
+      assert !key.revoked, 'A key is not revoked by default'
+    end
+  end
+  
+  describe '#details' do 
+    it 'assigns properties of a key and returns them' do 
+      VCR.use_cassette("details_for_a_given_key", match_requests_on: [:path]) do
+        key = LimeLm::Key.new({ 'id' => '1' })
+        result = key.details
+        assert !key.key.empty?, 'Details about a key should reassign the key property'
+        assert !key.email.empty?, 'Details about a key should reassign the email property'
+        assert result.is_a?(Hash), 'All the properties should be returned'
+      end
+    end
+
+    it 'including all custom license fields and tags' do
+      VCR.use_cassette("details_for_a_given_key_with_tags", match_requests_on: [:path]) do
+        key = LimeLm::Key.new({ 'id' => '1' })
+        result = key.details
+        assert_equal [{"name"=>"enterprise"}, {"name"=>"demo"}], result['tags']['tag']
+      end
+    end
+  end
+  
+  describe '#id' do 
+    it 'returns the id property if already present in the object' do 
+      key = LimeLm::Key.new({ 'id' => '1' })
+      assert_equal '1', key.id
+    end
+
+    it 'calls the API, save the id property and returns it if only the product key is present' do 
+      VCR.use_cassette("id_for_a_given_key", match_requests_on: [:path]) do
+        key = LimeLm::Key.new({ 'key' => 'AAAA-BBBB' })
+        assert_equal '1', key.id
+      end
+    end
+  end
+
+  describe '#tag' do
+    it 'sets a key tags providing an Array' do
+      VCR.use_cassette("set_tags_for_a_given_key", match_requests_on: [:path]) do
+        key = LimeLm::Key.new({ 'id' => '1' }) 
+        tags = ['demo', 'enterprise']
+        assert key.tag(tags), 'returns true if success'
+      end
+    end
+  end
+
+  describe '#remove_tag' do 
+    it 'removes the specialized tag' do 
+      VCR.use_cassette("remove_tag_for_a_given_key", match_requests_on: [:path]) do
+        key = LimeLm::Key.new({ 'id' => '1' }) 
+        assert key.remove_tag('demo'), 'returns true if success'
+      end
+    end
+  end
+
+  describe '#update' do 
+    #TODO: https://wyday.com/limelm/help/api/limelm.pkey.setDetails/
+  end 
+
+  describe '#toggle_revoke!' do 
+    it 'calls the API and set revoked to true in case of success for a non revoked key' do 
+      VCR.use_cassette("revoke_key", match_requests_on: [:path]) do
+        key = LimeLm::Key.new({ 'id' => '1' }) 
+        assert !key.revoked, 'By default a key is not revoked after its initialization'
+        key.toggle_revoke!
+        assert key.revoked, 'The key is revoked if succeed'
+      end
+    end
+
+    it 'calls the API and unrevoke the key' do 
+      VCR.use_cassette("unrevoke_key", match_requests_on: [:path]) do
+        key = LimeLm::Key.new({ 'id' => '1', 'revoked' => true }) 
+        assert key.revoked, 'the key should be revoked'
+        key.toggle_revoke!
+        assert !key.revoked, 'Unrevoke the key'
+      end
+    end
+  end
+
+  describe '.create' do 
+    it 'creates a new default product key' do 
+      VCR.use_cassette("create_key_default_configuration", match_requests_on: [:path]) do
+        result = LimeLm::Key.create
+        assert_equal 1, result.count, 'Should build an uniq key by default'
+        new_key = result.first
+        assert_instance_of LimeLm::Key, new_key
+        assert_equal '9', new_key.id
+        assert_equal 'CCCC-BBBB', new_key.key
+        assert new_key.version_id, 'version_id is set to the default configuration'
+      end
+    end
+
+    it 'associates keys to an email and can generate more than a key' do 
+      VCR.use_cassette("create_keys_with_email", match_requests_on: [:path]) do
+        email = 'imberdis.damien@gmail.com'
+
+        result = LimeLm::Key.create(email: email, num_keys: 2)
+        assert_equal 2, result.count
+
+        first_key, second_key = result.first, result.last
+        assert_instance_of LimeLm::Key, first_key
+        assert_instance_of LimeLm::Key, second_key
+
+        assert_equal email, first_key.email
+        assert_equal email, second_key.email
+      end
+    end
+
+    it 'accept more detailed configuration about the limitation of activations/deactivations' do 
+      VCR.use_cassette("create_detailed_key", match_requests_on: [:path]) do 
+        email = 'imberdis.damien@gmail.com'
+
+        result = LimeLm::Key.create(email: email, num_acts: 5, deact_limit: 2)
+        assert '9', result.first.id
+        assert 'CCCC-EEEE', result.first.key
+      end
+    end
+
+    it 'accepts the creation of a new key, specifying a product version_id (not using the default configuration)' do 
+      VCR.use_cassette("create_key_new_version", match_requests_on: [:path]) do
+        result = LimeLm::Key.create(version_id: '2')
+        assert_equal '2', result.first.version_id
+      end
+    end
+  end
+
+  describe '#destroy!' do 
+    it 'deletes a key' do 
+      VCR.use_cassette("destroy_key", match_requests_on: [:path]) do
+        key_to_destroy = LimeLm::Key.new({ 'id' => '1' })
+        assert key_to_destroy.destroy!, 'Should return true if key deleted'
+      end
+    end
+
+    it 'raises error if try to delete a key out of my version_id' do 
+      VCR.use_cassette("destroy_random_key", match_requests_on: [:path]) do
+        key_to_destroy = LimeLm::Key.new({ 'id' => '3' })
+        assert_raises(LimeLm::ApiError) { key_to_destroy.destroy! }   
+      end
+    end
+  end
+ 
+  describe '.find' do 
+    it 'returns a list of keys associated with an email' do 
+      email = 'imberdis.damien@gmail.com'
+      VCR.use_cassette("find_keys_by_email", match_requests_on: [:path]) do
+        keys = LimeLm::Key.find(email)
+        assert_equal 2, keys.count
+        key = keys.first
+        assert key.is_a?(LimeLm::Key)
+
+        assert key.properties.is_a?(Hash) && !key.properties.empty?, 'All data are stored as a Hash under properties'
+        assert !key.id.empty?, 'A key should contains the id information'
+        assert !key.key.empty?, 'A key should contains the key information'
+        assert !key.version_id.empty?, 'A key as a link to its product version'
+        assert !key.email.empty?, 'A key as a link to the user email provided'
+        assert !key.properties['acts'].empty?, 'A key should contains the total of activations information'
+        assert !key.properties['acts_used'].empty?, 'A key should contains the used activations information'
+      end
+    end
+  end
+
+  describe '.search' do 
+    it 'returns by default 20 keys of all products and versions' do 
+      VCR.use_cassette("default_search", match_requests_on: [:path]) do
+        result = LimeLm::Key.search
+        
+        # NOTE: the next values are only set for the purpose of a test
+        assert_equal 2, result.count
+        first_key, last_key = result.first, result.last
+
+        assert_instance_of LimeLm::Key, first_key
+        assert_equal '1', first_key.id
+        assert_equal '1', first_key.version_id
+
+        assert_instance_of LimeLm::Key, last_key
+        assert_equal '2', last_key.id
+        assert_equal '4', last_key.version_id
+      end 
+    end
+
+    it 'paginates the result returned' do 
+      VCR.use_cassette("default_search_pagination", match_requests_on: [:path]) do
+        result = LimeLm::Key.search(num: 2, page: 3)   
+        assert_equal 2, result.count
+
+        first_key = result.first
+        assert_instance_of LimeLm::Key, first_key
+        assert_equal '10', first_key.id
+        assert_equal '2', first_key.version_id
+      end
+    end
+  end
+end