lexer-identity 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a395e6932b3a744d3a9e85f22a14842139afa5dd
-  data.tar.gz: c1772af7cfaae2a992d2ddbc599edd3481913d70
+  metadata.gz: 4aa1b95c2239425aa1f672b4bf0c01b71d95c508
+  data.tar.gz: e6403c66dc95167a3bf47effe0010fd16809ac4b
 SHA512:
-  metadata.gz: dfd879f57b3a28d98d54033966dc35f6089a5df8d08f11935d78c1d6dbbb8fffa64cd27a2f4ad7d51a7092277129a36432bc4cf5773727d8ebb84755bf0c2ab4
-  data.tar.gz: 13284a564344bfc9220ec37a9d048d3f59b84761674bc8086858b9be3150dc5c42ce3588b0d5bc786019227b86d65208695e310e2523124ee1ebf07d5050399c
+  metadata.gz: 08ffdfa2c86c03f7a306f534dfea816ab4652d3bbe51c001c457dbe76a0f9da79a69aabe3171688f1d7adaa0436287275fc1f5677c371bc3ba4078bb7cafa753
+  data.tar.gz: b376a1ab3a4d4e661a826cc350e4da0cc7d2d201f77a356d99dc5ea54f2d6d8b8f7275df178cfdfe0043a0d2a1f2c85af4df9d563a9523f196b1bbb644028655

data/README.md

@@ -1,9 +1,9 @@
 # Lexer Identities Official Ruby Client Library
 
-[![Build Status](https://travis-ci.org/lexerdev/lexer-identity-gem.svg)](http://travis-ci.org/lexerdev/lexer-identity-gem)
-[![Code Climate](https://codeclimate.com/github/lexerdev/lexer-identity-gem/badges/gpa.svg)](https://codeclimate.com/github/lexerdev/lexer-identity-gem)
+[![Build Status](https://travis-ci.org/lexerdev/identity-gem.svg)](http://travis-ci.org/lexerdev/identity-gem)
+[![Code Climate](https://codeclimate.com/github/lexerdev/identity-gem/badges/gpa.svg)](https://codeclimate.com/github/lexerdev/identity-gem)
 
-lexer-identity-gem is the official Ruby Client for the [Lexer Identity](https://lexer.io/) API. The
+Lexer Identity Gem is the official Ruby Client for the [Lexer Identity](https://lexer.io/) API. The
 Lexer Identity API lets brands contribute and consume from Lexer's Identity database directly from their apps.
 
 ## Installation

data/Rakefile

@@ -8,4 +8,4 @@ Rake::TestTask.new do |t|
   t.libs.push 'spec'
 end
 
-task :default => [:test]
+task default: [:test]

data/lib/lexer/identity/api.rb

@@ -5,28 +5,51 @@ require 'multi_json'
 module Lexer
   # :nordoc:
   module Identity
+    # Constants for attribute confidence
+    CONFIDENCE_PROVIDED = 2
+    CONFIDENCE_CALCULATED = 1
+    CONFIDENCE_INFERRED = 0
+
     # The backbone of the Identity API.
     # Enrich accepts links and attributes as per the
     # API Documentation hosted at http://developer.lexer.io/
     #
     # Options:
     #
+    # +id+         - A string of the Lexer Identity ID to lookup
     # +links+      - A hash of links to search for and link to the identity. Default: {}.
     # +attributes+ - A hash of attributes where keys are valid namespaces. Default: {}.
     #
+    # An +id+ or +links+ is required for a valid request.
+    #
     # Response:
     #
     # A hash containing the Lexer Identity ID and any attributes on the identity
     #
-    def self.enrich(links: {}, attributes: {})
+    def self.enrich(id: nil, links: {}, attributes: {})
+      body = {}
+
       # ensure the module is configured
       fail Lexer::Identity::ConfigurationError, 'Module has not been configured.' if configuration.nil?
       configuration.validate
 
-      # produce the request body
-      body = {}
-      body[:links] = links
-      body[:attributes] = attributes unless configuration.contributor_token.nil?
+      # use the id if provided
+      if id.nil?
+        if links.keys.size == 0
+          fail Lexer::Identity::MissingLinksError, 'An ID or Link is required'
+        else
+          body[:links] = links
+        end
+      else
+        body[:id] = id
+      end
+
+      # only include attributes if contributing
+      if !configuration.contributor_token.nil? && attributes.keys.size > 0
+        self.validate_attributes attributes
+        body[:attributes] = attributes
+      end
+
       body[:api_token] = configuration.api_token unless configuration.api_token.nil?
       body[:contributor_token] = configuration.contributor_token unless configuration.contributor_token.nil?
       body[:consumer_token] = configuration.consumer_token unless configuration.consumer_token.nil?
@@ -36,6 +59,17 @@ module Lexer
 
     private
 
+    def self.validate_attributes attributes
+      attributes.each { |k, v|
+        unless v.is_a? Hash
+          fail Lexer::Identity::AttributePayloadError, "#{k} is not a hash"
+        end
+        unless v.has_key?(:value) && v.has_key?(:confidence)
+          fail Lexer::Identity::AttributePayloadError, "#{k} has an invalid payload"
+        end
+      }
+    end
+
     def self.post_request(body)
       uri = URI(configuration.api_url)
       header = { 'Content-Type' => 'application/json' }
@@ -55,13 +89,13 @@ module Lexer
       when 200..204
         Lexer::Identity::EnrichedResult.from_json response.body
       when 400
-        fail Lexer::Identity::BadRequestError, response_body
+        fail Lexer::Identity::BadRequestError, response.body
       when 401
-        fail Lexer::Identity::AuthenticationError, response_body
+        fail Lexer::Identity::AuthenticationError, response.body
       when 404
-        fail Lexer::Identity::NotFoundError, response_body
+        fail Lexer::Identity::NotFoundError, response.body
       else
-        fail Lexer::Identity::HttpError, response_body
+        fail Lexer::Identity::HttpError, response.body
       end
     end
   end

data/lib/lexer/identity/version.rb

@@ -4,6 +4,6 @@
 module Lexer
   # :nordoc:
   module Identity
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/lexer/identity.rb

@@ -22,7 +22,7 @@ module Lexer
   #     config.consumer_token = "..."
   #   end
   #
-  #   Lexer::Identity.enrich( links: { email: "...", ... }, attributes: { "com.mybrand.name": "...", ... } )
+  #   Lexer::Identity.enrich( id: "...", links: { email: "...", ... }, attributes: { "com.mybrand.name": "...", ... } )
   #
   # See the +Lexer::Identity.enrich+ documentation for more details.
   module Identity
@@ -44,6 +44,12 @@ module Lexer
     # Will be thrown when there is an error with the Module's configuration
     class ConfigurationError < Error; end
 
+    # Thrown when the attribute payload is not valid
+    class AttributePayloadError < Error; end
+
+    # Thrown when a request does not contain an ID or Link
+    class MissingLinksError < Error; end
+
     # Will be thrown when there is an error communicating with the API
     # Also inherited by other errors
     class HttpError < Error; end

data/spec/lexer/identity/api_spec.rb

@@ -2,43 +2,149 @@
 require 'spec_helper'
 
 describe Lexer::Identity do
-  describe 'contributions' do
+  describe 'constants' do
+    it 'has required constants' do
+      Lexer::Identity::CONFIDENCE_PROVIDED.wont_be_nil
+      Lexer::Identity::CONFIDENCE_CALCULATED.wont_be_nil
+      Lexer::Identity::CONFIDENCE_INFERRED.wont_be_nil
+    end
+  end
+
+  describe 'use of links and ids' do
     before do
       Lexer::Identity.configuration = nil
       Lexer::Identity.configure do |config|
         config.api_token = 'abc-123'
         config.contributor_token = 'bcd-234'
+        config.consumer_token = 'cde-345'
       end
     end
-    it 'produces a valid request' do
+    it 'requires either a link or id' do
+      proc do
+        Lexer::Identity.enrich
+      end.must_raise Lexer::Identity::MissingLinksError
+    end
+    it 'requires at least one link' do
+      proc do
+        Lexer::Identity.enrich(
+          links: {}
+        )
+      end.must_raise Lexer::Identity::MissingLinksError
+    end
+    it 'produces a valid request with links' do
       stub_request(:post, 'https://identity.lexer.io/identity').
-        with(body: '{"links":{"email":["user1@brand.com","usera@brand.com"],"mobile":"61440000000"},"attributes":{"com.brand.car":"Tesla","com.brand.code":10,"com.brand.products":["a","b","c"],"com.brand.detail":{"make":"cake"}},"api_token":"abc-123","contributor_token":"bcd-234"}', headers: { 'Content-Type' => 'application/json' }).
+        with(body: '{"links":{"email":["user1@brand.com","usera@brand.com"],"mobile":"61440000000"},"api_token":"abc-123","contributor_token":"bcd-234","consumer_token":"cde-345"}', headers: { 'Content-Type' => 'application/json' }).
         to_return(status: 200, body: '{"id":"0a224111-ac64-4142-9198-adf8bf2c1a04"}')
 
       Lexer::Identity.enrich(
         links: {
           email: %w(user1@brand.com usera@brand.com),
           mobile: '61440000000'
-        }, attributes: {
-          'com.brand.car' => 'Tesla',
-          'com.brand.code' => 10,
-          'com.brand.products' => %w(a b c),
-          'com.brand.detail' => { make: 'cake' }
         }
       )
 
       assert_requested(:post, 'https://identity.lexer.io/identity', times: 1)
     end
+    it 'produces a valid request with an ID' do
+      stub_request(:post, 'https://identity.lexer.io/identity').
+        with(body: '{"id":"0a224111-ac64-4142-9198-adf8bf2c1a04","api_token":"abc-123","contributor_token":"bcd-234","consumer_token":"cde-345"}', headers: { 'Content-Type' => 'application/json' }).
+        to_return(status: 200, body: '{"id":"0a224111-ac64-4142-9198-adf8bf2c1a04"}')
+
+      Lexer::Identity.enrich(
+        id: '0a224111-ac64-4142-9198-adf8bf2c1a04'
+      )
+
+      assert_requested(:post, 'https://identity.lexer.io/identity', times: 1)
+    end
+    it 'ignores links when an ID is present' do
+      stub_request(:post, 'https://identity.lexer.io/identity').
+        with(body: '{"id":"0a224111-ac64-4142-9198-adf8bf2c1a04","api_token":"abc-123","contributor_token":"bcd-234","consumer_token":"cde-345"}', headers: { 'Content-Type' => 'application/json' }).
+        to_return(status: 200, body: '{"id":"0a224111-ac64-4142-9198-adf8bf2c1a04"}')
+
+      Lexer::Identity.enrich(
+        id: '0a224111-ac64-4142-9198-adf8bf2c1a04',
+        links: {
+          email: %w(user1@brand.com usera@brand.com),
+          mobile: '61440000000'
+        }
+      )
+
+      assert_requested(:post, 'https://identity.lexer.io/identity', times: 1)
+    end
+  end
+
+  describe 'contributions' do
+    before do
+      Lexer::Identity.configuration = nil
+      Lexer::Identity.configure do |config|
+        config.api_token = 'abc-123'
+        config.contributor_token = 'bcd-234'
+      end
+    end
+    describe 'attribute payloads' do
+      it 'requires a complete payload' do
+        proc do
+          Lexer::Identity.enrich(
+            id: 'abc-123',
+            attributes: {
+              'com.brand.car' => 'Tesla'
+            }
+          )
+        end.must_raise Lexer::Identity::AttributePayloadError
+
+        proc do
+          Lexer::Identity.enrich(
+            id: 'abc-123',
+            attributes: {
+              'com.brand.car' => {
+                value: 'attribute value'
+              }
+            }
+          )
+        end.must_raise Lexer::Identity::AttributePayloadError
+
+        proc do
+          Lexer::Identity.enrich(
+            id: 'abc-123',
+            attributes: {
+              'com.brand.car' => {
+                confidence: Lexer::Identity::CONFIDENCE_PROVIDED
+              }
+            }
+          )
+        end.must_raise Lexer::Identity::AttributePayloadError
+      end
+      it 'allows a complete payload' do
+        stub_request(:post, 'https://identity.lexer.io/identity').
+          with(body: '{"id":"0a224111-ac64-4142-9198-adf8bf2c1a04","attributes":{"com.brand.car":{"value":"Tesla","confidence":2}},"api_token":"abc-123","contributor_token":"bcd-234"}', headers: { 'Content-Type' => 'application/json' }).
+          to_return(status: 200, body: '{"id":"0a224111-ac64-4142-9198-adf8bf2c1a04"}')
+
+        Lexer::Identity.enrich(
+          id: '0a224111-ac64-4142-9198-adf8bf2c1a04',
+          attributes: {
+            'com.brand.car' => {
+              value: 'Tesla',
+              confidence: Lexer::Identity::CONFIDENCE_PROVIDED
+            }
+          }
+        )
+
+        assert_requested(:post, 'https://identity.lexer.io/identity', times: 1)
+      end
+    end
     it 'returns an EnrichedResult' do
       stub_request(:post, 'https://identity.lexer.io/identity').
-        with(body: '{"links":{"email":"user1@brand.com"},"attributes":{"com.brand.car":"Tesla"},"api_token":"abc-123","contributor_token":"bcd-234"}', headers: { 'Content-Type' => 'application/json' }).
+        with(body: '{"links":{"email":"user1@brand.com"},"attributes":{"com.brand.car":{"value":"Tesla","confidence":2}},"api_token":"abc-123","contributor_token":"bcd-234"}', headers: { 'Content-Type' => 'application/json' }).
         to_return(status: 200, body: '{"id":"0a224111-ac64-4142-9198-adf8bf2c1a04"}')
 
       result = Lexer::Identity.enrich(
         links: {
           email: 'user1@brand.com'
         }, attributes: {
-          'com.brand.car' => 'Tesla'
+          'com.brand.car' => {
+            value: 'Tesla',
+            confidence: Lexer::Identity::CONFIDENCE_PROVIDED
+          }
         }
       )
 
@@ -59,14 +165,17 @@ describe Lexer::Identity do
     it 'produces a valid request' do
       stub_request(:post, 'https://identity.lexer.io/identity').
         with(body: '{"links":{"email":["user1@brand.com","usera@brand.com"],"mobile":"61440000000"},"api_token":"abc-123","consumer_token":"bcd-234"}', headers: { 'Content-Type' => 'application/json' }).
-        to_return(status: 200, body: '{"id":"0a224111-ac64-4142-9198-adf8bf2c1a04","attributes":{"com.brand.car":"Tesla","com.brand.code":10,"com.brand.products":["a","b","c"],"com.brand.detail":{"make":"cake"}}}')
+        to_return(status: 200, body: '{"id":"0a224111-ac64-4142-9198-adf8bf2c1a04","attributes":{"com.brand.car":{"value":"Tesla","confidence":2},"com.brand.code":{"value":10,"confidence":2},"com.brand.products":{"value":["a","b","c"],"confidence":1},"com.brand.detail":{"value":{"make":"cake"},"confidence":0}}}')
 
       Lexer::Identity.enrich(
         links: {
           email: %w(user1@brand.com usera@brand.com),
           mobile: '61440000000'
         }, attributes: {
-          'com.brand.car' => 'Tesla' # note: this will be discarded as consumers can't contribute
+          'com.brand.car' => {
+            value: 'Tesla',
+            confidence: Lexer::Identity::CONFIDENCE_PROVIDED
+          }
         }
       )
 
@@ -75,20 +184,40 @@ describe Lexer::Identity do
     it 'returns an EnrichedResult' do
       stub_request(:post, 'https://identity.lexer.io/identity').
         with(body: '{"links":{"email":["user1@brand.com","usera@brand.com"],"mobile":"61440000000"},"api_token":"abc-123","consumer_token":"bcd-234"}', headers: { 'Content-Type' => 'application/json' }).
-        to_return(status: 200, body: '{"id":"0a224111-ac64-4142-9198-adf8bf2c1a04","attributes":{"com.brand.car":"Tesla","com.brand.code":10,"com.brand.products":["a","b","c"],"com.brand.detail":{"make":"cake"}}}')
+        to_return(status: 200, body: '{"id":"0a224111-ac64-4142-9198-adf8bf2c1a04","attributes":{"com.brand.car":{"value":"Tesla","confidence":2},"com.brand.code":{"value":10,"confidence":2},"com.brand.products":{"value":["a","b","c"],"confidence":1},"com.brand.detail":{"value":{"make":"cake"},"confidence":0}}}')
 
       result = Lexer::Identity.enrich(
         links: {
           email: %w(user1@brand.com usera@brand.com),
           mobile: '61440000000'
         }, attributes: {
-          'com.brand.car' => 'Tesla' # note: this will be discarded as consumers can't contribute
+          'com.brand.car' => {
+            value: 'Tesla',
+            confidence: Lexer::Identity::CONFIDENCE_PROVIDED
+          }
         }
       )
 
       result.must_be_instance_of Lexer::Identity::EnrichedResult
       result.id.must_be_kind_of String
-      hash = { 'com.brand.car' => 'Tesla', 'com.brand.code' => 10, 'com.brand.products' => %w(a b c), 'com.brand.detail' => { 'make' => 'cake' } }
+      hash = {
+        'com.brand.car' => {
+          'value' => 'Tesla',
+          'confidence' => 2
+        },
+        'com.brand.code' => {
+          'value' => 10,
+          'confidence' => 2
+        },
+        'com.brand.products' => {
+          'value' => %w(a b c),
+          'confidence' => 1
+        },
+        'com.brand.detail' => {
+          'value' => { 'make' => 'cake' },
+          'confidence' => 0
+        }
+      }
       result.attributes.must_equal hash
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lexer-identity
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aaron Wallis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-07 00:00:00.000000000 Z
+date: 2015-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json