lexer-identity 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4aa1b95c2239425aa1f672b4bf0c01b71d95c508
-  data.tar.gz: e6403c66dc95167a3bf47effe0010fd16809ac4b
+  metadata.gz: 70990bc536acb39402aa3585d646cf30e092449b
+  data.tar.gz: e806dea0b0c8fd7b87189a193c10ada70b4ec8ea
 SHA512:
-  metadata.gz: 08ffdfa2c86c03f7a306f534dfea816ab4652d3bbe51c001c457dbe76a0f9da79a69aabe3171688f1d7adaa0436287275fc1f5677c371bc3ba4078bb7cafa753
-  data.tar.gz: b376a1ab3a4d4e661a826cc350e4da0cc7d2d201f77a356d99dc5ea54f2d6d8b8f7275df178cfdfe0043a0d2a1f2c85af4df9d563a9523f196b1bbb644028655
+  metadata.gz: 81e3545ca200b23118642898bbcc09a186964eda906eef235990cfdd27510780cb1670db61ed43ba770632844cb5904a0c040113d78eca01ff7f46e7298d4ffc
+  data.tar.gz: ff1e6ba86f340c722bd6b89d56d003325dfad2410f773e69ecc467a8a2e90866cbecb31d4b9e6d28bba8041ed102f1a2d127db7652f10487121ee2755801ce82

data/README.md

@@ -2,10 +2,12 @@
 
 [![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)
+[![Gem Version](https://badge.fury.io/rb/lexer-identity.svg)](http://badge.fury.io/rb/lexer-identity)
 
 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
 
 Add to your Gemfile:
@@ -16,51 +18,23 @@ or install from Rubygems:
 
     gem install lexer-identity
 
+And include it in your project as:
 
-## Details
-
-### Links:
-
-Have a limited list of keys which can be reviewed at: http://developer.lexer.io/
-Your hash should reflect the following format:
-
-    {
-      email: "joe.smith@mybrand.com",
-      phone: "61440000000",
-      twitter: "camplexer"
-    }
-
-Multiple values can be provided via arrays:
-
-    {
-      email: ["joe.smith@mybrand.com", "j.smith@mybrand.com"],
-      phone: "61440000000",
-      twitter: "camplexer"
-    }
-
-### Attributes:
-
-Need to be defined by the valid namespace which should be provided
-to you along with your tokens.
-An attribute namespace is defined by: `com.brand.*` where `com.brand`
-is defined along with your tokens and `*` can be replaced with any
-`A-Za-z0-9._-` character.
-
-Your attribute hash should reflect the following format:
+    require 'lexer'
 
-    {
-      "com.brand.email" => "joe.smith@mybrand.com",
-      "com.brand.phone" => "61440000000",
-      "com.brand.twitter" => "camplexer"
-    }
 
-Permitted values include:
+## Use
 
-- String
-- Numbers
-- Arrays
-- Simple Hashes
+    # Configure using the provided tokens
+    Lexer::Identity.configure do |config|
+      config.api_token = "..."
+      config.contributor_token = "..."
+      config.consumer_token = "..."
+    end
+  
+    # Communicate via the enrich method
+    Lexer::Identity.enrich( links: { email: "test@lexer.io", twitter: "camplexer" }, attributes: { "io.lexer.name": { value: "Jane Smith", confidence: Lexer::Identity::CONFIDENCE_PROVIDED, ... } )
 
-Attribute hashes are transported via JSON so any format supported
-by JSON is supported by Lexer.
+## Further Reading
 
+See the full documentation at http://developer.lexer.io.

data/lexer-identity.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.licenses    = ['MIT']
   s.authors     = ['Aaron Wallis']
   s.email       = 'code@Lexer.io'
-  s.homepage    = 'https://github.com/lexerdev/lexer-identity-api.gem'
+  s.homepage    = 'https://github.com/lexerdev/identity-gem'
   s.summary     = 'Lexer Identity API Client'
   s.description = 'Consume and Contribute Identity data from your Ruby applications.'
 

data/lib/lexer/identity/api.rb

@@ -59,15 +59,16 @@ module Lexer
 
     private
 
-    def self.validate_attributes attributes
-      attributes.each { |k, v|
+    def self.validate_attributes(attributes)
+      attributes.each do |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)
+
+        unless [:value, :confidence].all? { |required_key| v.key?(required_key) || v.key?(required_key.to_s) }
           fail Lexer::Identity::AttributePayloadError, "#{k} has an invalid payload"
         end
-      }
+      end
     end
 
     def self.post_request(body)

data/lib/lexer/identity/version.rb

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

data/spec/lexer/identity/api_spec.rb

@@ -114,6 +114,33 @@ describe Lexer::Identity do
           )
         end.must_raise Lexer::Identity::AttributePayloadError
       end
+      it 'accepts symbols or string keys' 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
+            }
+          }
+        )
+
+        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: 2)
+      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' }).
@@ -129,6 +156,26 @@ describe Lexer::Identity do
           }
         )
 
+        assert_requested(:post, 'https://identity.lexer.io/identity', times: 1)
+      end
+      it 'allows a metadata 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,"metadata":{"extra":"data"}}},"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,
+              metadata: {
+                extra: "data"
+              }
+            }
+          }
+        )
+
         assert_requested(:post, 'https://identity.lexer.io/identity', times: 1)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lexer-identity
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Aaron Wallis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -48,7 +48,7 @@ files:
 - spec/lexer/identity/configuration_spec.rb
 - spec/lexer/identity_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/lexerdev/lexer-identity-api.gem
+homepage: https://github.com/lexerdev/identity-gem
 licenses:
 - MIT
 metadata: {}