lexer-identity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a395e6932b3a744d3a9e85f22a14842139afa5dd
+  data.tar.gz: c1772af7cfaae2a992d2ddbc599edd3481913d70
+SHA512:
+  metadata.gz: dfd879f57b3a28d98d54033966dc35f6089a5df8d08f11935d78c1d6dbbb8fffa64cd27a2f4ad7d51a7092277129a36432bc4cf5773727d8ebb84755bf0c2ab4
+  data.tar.gz: 13284a564344bfc9220ec37a9d048d3f59b84761674bc8086858b9be3150dc5c42ce3588b0d5bc786019227b86d65208695e310e2523124ee1ebf07d5050399c

data/.gitignore

@@ -0,0 +1,6 @@
+*.bundle
+tmp
+.env
+log
+*.gem
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/Encoding:
+  Enabled: true
+
+Metrics/LineLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+bundler_args: --without development
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.2.0
+  - jruby-19mode
+
+before_install:
+  - gem update bundler
+  - bundle --version
+  - gem update --system 2.1.11
+  - gem --version

data/Gemfile

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'rake'
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'webmock'
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Lexer
+
+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,66 @@
+# 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)
+
+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:
+
+    gem 'lexer-identity'
+
+or install from Rubygems:
+
+    gem install lexer-identity
+
+
+## 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:
+
+    {
+      "com.brand.email" => "joe.smith@mybrand.com",
+      "com.brand.phone" => "61440000000",
+      "com.brand.twitter" => "camplexer"
+    }
+
+Permitted values include:
+
+- String
+- Numbers
+- Arrays
+- Simple Hashes
+
+Attribute hashes are transported via JSON so any format supported
+by JSON is supported by Lexer.
+

data/Rakefile

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'bundler'
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs.push 'spec'
+end
+
+task :default => [:test]

data/lexer-identity.gemspec

@@ -0,0 +1,30 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+require 'lexer/identity/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'lexer-identity'
+  s.version     = Lexer::Identity::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ['MIT']
+  s.authors     = ['Aaron Wallis']
+  s.email       = 'code@Lexer.io'
+  s.homepage    = 'https://github.com/lexerdev/lexer-identity-api.gem'
+  s.summary     = 'Lexer Identity API Client'
+  s.description = 'Consume and Contribute Identity data from your Ruby applications.'
+
+  s.add_dependency 'multi_json', '~> 1.3'
+
+  s.files = `git ls-files`.split($RS).reject do |file|
+    file =~ %r{^(?:
+    spec/.*
+    |Gemfile
+    |Rakefile
+    |\.gitignore
+    |\.rubocop.yml
+    |\.travis.yml
+    )$}x
+  end
+  s.test_files    = `git ls-files`.split($RS)
+  s.require_paths = ['lib']
+end

data/lib/lexer.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+# The base Lexer module that may contain one or more Public or Private Lexer modules.
+module Lexer
+end
+
+require 'lexer/identity'

data/lib/lexer/identity.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+require 'logger'
+
+module Lexer
+  # Identity allows businesses to Contribute or Consume data from
+  # the Lexer Identity platform.
+  #
+  # The module acts as a light wrapper to the Identity API who's
+  # documentation can be found at http://lexer.io.
+  #
+  # See +Lexer::Identity.configuration+ and
+  # +Lexer::Identity.enrich+ for more details.
+  #
+  # To use the API you will first require API tokens which should have
+  # been provided to you already, or can be obtained from support@lexer.io.
+  #
+  # Basic use of the gem is as follows:
+  #
+  #   Lexer::Identity.configure do |config|
+  #     config.api_token = "..."
+  #     config.contributor_token = "..."
+  #     config.consumer_token = "..."
+  #   end
+  #
+  #   Lexer::Identity.enrich( links: { email: "...", ... }, attributes: { "com.mybrand.name": "...", ... } )
+  #
+  # See the +Lexer::Identity.enrich+ documentation for more details.
+  module Identity
+    # Base RuntimeError class for Identity related errors.
+    # Most Lexer and Identiy errors inherit this class.
+    class Error < RuntimeError
+      attr_accessor :original_error
+      def initialize(message, original = nil)
+        self.original_error = original
+        Lexer::Identity.logger.error("#{self}: #{message}")
+        super(message)
+      end
+
+      def to_s
+        "Lexer Identity Exception: #{super}"
+      end
+    end
+
+    # Will be thrown when there is an error with the Module's configuration
+    class ConfigurationError < Error; end
+
+    # Will be thrown when there is an error communicating with the API
+    # Also inherited by other errors
+    class HttpError < Error; end
+
+    # Will be thrown when there is an error in the API request
+    class BadRequestError < HttpError; end
+
+    # Will be thrown when the tokens are invalid
+    class AuthenticationError < HttpError; end
+
+    # Will be thrown when the object can't be loaded from the API
+    class NotFoundError < HttpError; end
+
+    # inherit configuration
+    class << self
+      attr_accessor :configuration
+      attr_writer :logger
+
+      # Defines the modules logger
+      # Accessible via:
+      #
+      #    Lexer::Identity.logger
+      #
+      def logger
+        @logger ||= lambda do
+          logger = Logger.new($stdout)
+          logger.level = Logger::INFO
+          logger
+        end.call
+      end
+    end
+
+    # Creates or uses active configutation
+    # See +Lexer::Identity.configuration+ for options
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+
+      self.configuration
+    end
+  end
+end
+
+require 'lexer/identity/configuration'
+require 'lexer/identity/api'
+require 'lexer/identity/enriched_result'

data/lib/lexer/identity/api.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+require 'multi_json'
+
+# :nordoc:
+module Lexer
+  # :nordoc:
+  module Identity
+    # The backbone of the Identity API.
+    # Enrich accepts links and attributes as per the
+    # API Documentation hosted at http://developer.lexer.io/
+    #
+    # Options:
+    #
+    # +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: {}.
+    #
+    # Response:
+    #
+    # A hash containing the Lexer Identity ID and any attributes on the identity
+    #
+    def self.enrich(links: {}, attributes: {})
+      # 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?
+      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?
+
+      post_request body
+    end
+
+    private
+
+    def self.post_request(body)
+      uri = URI(configuration.api_url)
+      header = { 'Content-Type' => 'application/json' }
+      request = Net::HTTP::Post.new(uri, header)
+      request.body = MultiJson.encode(body)
+
+      # XXX: SSL VALIDATION IS DISABLED - BAD BAD BAD
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true, verify_mode: OpenSSL::SSL::VERIFY_NONE) do |http|
+        http.request(request)
+      end
+
+      parse_response response
+    end
+
+    def self.parse_response(response)
+      case response.code.to_i
+      when 200..204
+        Lexer::Identity::EnrichedResult.from_json response.body
+      when 400
+        fail Lexer::Identity::BadRequestError, response_body
+      when 401
+        fail Lexer::Identity::AuthenticationError, response_body
+      when 404
+        fail Lexer::Identity::NotFoundError, response_body
+      else
+        fail Lexer::Identity::HttpError, response_body
+      end
+    end
+  end
+end

data/lib/lexer/identity/configuration.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+# :nordoc:
+module Lexer
+  # :nordoc:
+  module Identity
+    # Stores configuration details for communicating with the Lexer Identiy API.
+    class Configuration
+      # The full path to the API and endpoint
+      attr_accessor :api_url
+
+      # the API token provided by Lexer
+      attr_accessor :api_token
+
+      # the contributor token provided by Lexer
+      attr_accessor :contributor_token
+
+      # the consumer token provided by Lexer
+      attr_accessor :consumer_token
+
+      # Creates the configuration instance and defines default values
+      def initialize
+        @api_url = 'https://identity.lexer.io/identity'
+        @api_token = nil
+        @contributor_token = nil
+        @consumer_token = nil
+      end
+
+      # validates the current configuration, raising exceptions when invalid
+      def validate
+        fail Lexer::Identity::ConfigurationError, 'An API token is required' if @api_token.nil?
+        fail Lexer::Identity::ConfigurationError, 'A Contributor or Consumer token is required' if @contributor_token.nil? && @consumer_token.nil?
+        fail Lexer::Identity::ConfigurationError, 'Contributor and Consumer tokens are not interchangable' if @contributor_token == @consumer_token
+      end
+    end
+  end
+end

data/lib/lexer/identity/enriched_result.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'multi_json'
+
+# :nordoc:
+module Lexer
+  # :nordoc:
+  module Identity
+    # The treturned result of an +Lexer::Identity.enrich+ request.
+    # Contains accessors for the returned +id+ and +attributes+.
+    class EnrichedResult
+      attr_accessor :id
+      attr_accessor :attributes
+
+      def initialize(args)
+        args.each do |k, v|
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+      end
+
+      def self.from_json(json)
+        data = MultiJson.decode(json)
+        Lexer::Identity::EnrichedResult.new(data)
+      end
+    end
+  end
+end

data/lib/lexer/identity/version.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+# :nordoc:
+module Lexer
+  # :nordoc:
+  module Identity
+    VERSION = '0.1.0'
+  end
+end

data/spec/lexer/identity/api_spec.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Lexer::Identity do
+  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
+    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"},"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' }).
+        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 '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' }).
+        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'
+        }
+      )
+
+      result.must_be_instance_of Lexer::Identity::EnrichedResult
+      result.id.must_be_kind_of String
+      result.attributes.must_be_nil
+    end
+  end
+
+  describe 'consumptions' do
+    before do
+      Lexer::Identity.configuration = nil
+      Lexer::Identity.configure do |config|
+        config.api_token = 'abc-123'
+        config.consumer_token = 'bcd-234'
+      end
+    end
+    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"}}}')
+
+      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
+        }
+      )
+
+      assert_requested(:post, 'https://identity.lexer.io/identity', times: 1)
+    end
+    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"}}}')
+
+      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
+        }
+      )
+
+      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' } }
+      result.attributes.must_equal hash
+    end
+  end
+end

data/spec/lexer/identity/configuration_spec.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Lexer::Identity do
+  before do
+    Lexer::Identity.configuration = nil
+  end
+
+  describe 'configuration setup' do
+    it 'has valid defaults' do
+      Lexer::Identity.configure {}
+
+      config = Lexer::Identity.configuration
+
+      config.api_url.must_equal 'https://identity.lexer.io/identity'
+      config.api_token.must_be_nil
+      config.consumer_token.must_be_nil
+      config.contributor_token.must_be_nil
+    end
+    it 'sets configuration arguments' do
+      Lexer::Identity.configure do |config|
+        config.api_token = 'abc123'
+        config.consumer_token = 'abc124'
+        config.contributor_token = 'abc125'
+      end
+
+      config = Lexer::Identity.configuration
+
+      config.api_url.must_equal 'https://identity.lexer.io/identity'
+      config.api_token.must_equal 'abc123'
+      config.consumer_token.must_equal 'abc124'
+      config.contributor_token.must_equal 'abc125'
+    end
+  end
+
+  describe 'configuration validation' do
+    it 'validates the presense of an API token' do
+      Lexer::Identity.configure {}
+      proc { Lexer::Identity.configuration.validate }.must_raise Lexer::Identity::ConfigurationError
+    end
+    it 'validates the presense of a contributor or consumer token' do
+      Lexer::Identity.configure do |config|
+        config.api_token = 'abc123'
+      end
+      proc { Lexer::Identity.configuration.validate }.must_raise Lexer::Identity::ConfigurationError
+    end
+    it 'validates the difference of a contributor or consumer token' do
+      Lexer::Identity.configure do |config|
+        config.api_token = 'abc123'
+        config.contributor_token = 'abc123'
+        config.consumer_token = 'abc123'
+      end
+      proc { Lexer::Identity.configuration.validate }.must_raise Lexer::Identity::ConfigurationError
+    end
+  end
+end

data/spec/lexer/identity_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Lexer::Identity do
+  describe 'versioning' do
+    it 'returns a version' do
+      Lexer::Identity::VERSION.wont_be_nil
+    end
+  end
+
+  describe 'logger' do
+    it 'should be set to info' do
+      Lexer::Identity.logger.level.must_equal Logger::INFO
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'Use of Bundler is recommended'
+end
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'webmock/minitest'
+
+require File.expand_path('../../lib/lexer', __FILE__)
+
+Minitest::Reporters.use!(
+  [Minitest::Reporters::SpecReporter.new],
+  ENV,
+  Minitest.backtrace_filter
+)

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: lexer-identity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Wallis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Consume and Contribute Identity data from your Ruby applications.
+email: code@Lexer.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lexer-identity.gemspec
+- lib/lexer.rb
+- lib/lexer/identity.rb
+- lib/lexer/identity/api.rb
+- lib/lexer/identity/configuration.rb
+- lib/lexer/identity/enriched_result.rb
+- lib/lexer/identity/version.rb
+- spec/lexer/identity/api_spec.rb
+- spec/lexer/identity/configuration_spec.rb
+- spec/lexer/identity_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lexerdev/lexer-identity-api.gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Lexer Identity API Client
+test_files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lexer-identity.gemspec
+- lib/lexer.rb
+- lib/lexer/identity.rb
+- lib/lexer/identity/api.rb
+- lib/lexer/identity/configuration.rb
+- lib/lexer/identity/enriched_result.rb
+- lib/lexer/identity/version.rb
+- spec/lexer/identity/api_spec.rb
+- spec/lexer/identity/configuration_spec.rb
+- spec/lexer/identity_spec.rb
+- spec/spec_helper.rb
+has_rdoc: