cognito-client 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f68b740a5ba516167ad1927faf7372906f7a4cd
-  data.tar.gz: fc8c54beb597ceb364c16d8f4474f917c0ddfad2
+  metadata.gz: 86e3186a7250f7e2aece863f01c09823bdff4864
+  data.tar.gz: 7d3ac5b3649e5027f309ced4325b132e369b5385
 SHA512:
-  metadata.gz: e3bc88bf4ad7896032056f5f6e6c245ef34071953b9e62aa3824dde40e8542e44b904917b3faa4daf1de1f5d8ec9297a8b7bb1af2e076a5cf2e570cf92bdbb81
-  data.tar.gz: e2906b5cfd7bab859723b88368168b047821da3a8b805c902504ae925d54402028b264247791e962f1c28b4f74cfd97a9411fa7f5ed17d64d5b9357dfa24b5e8
+  metadata.gz: f60da529529285bc97b3ead92afbd912a5c82314b2725b914afffb19b5d26769d111c1f20f8b78a00f4cc3dfce01d71898298b51bf58a4615dce2df49f705413
+  data.tar.gz: 3c18ced1a8f32d98ab893982135b358851536b3822706bc824370eac98ef30a9ada94bfbaa34c35280b532c415cc19877ee5b7fd91d20e0fbf9d9b3b0a4cbd69

data/.rspec

@@ -1,2 +1,3 @@
---format documentation
 --color
+--format documentation
+--require spec_helper

data/Gemfile

@@ -3,3 +3,40 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cognito.gemspec
 gemspec
+
+group(:tools) do
+  # mutation testing tool for ruby
+  gem 'mutant',       '~> 0.8.10'
+
+  # Rspec integration for mutant
+  gem 'mutant-rspec', '~> 0.8.8'
+
+  # Watches file system and invokes commands according to mapping rules
+  gem 'guard',        '~> 2.14.0'
+
+  # Plugin to guard for RSpec tooling
+  gem 'guard-rspec',  '~> 4.7.2'
+
+  # A metagem wrapping development tools:
+  #   procto,
+  #   adamantium,
+  #   anima,
+  #   concord,
+  #   rspec, rspec-core, rspec-its
+  #   rake,
+  #   yard,
+  #   flog,
+  #   flay,
+  #   reek,
+  #   rubocop,
+  #   simplecov,
+  #   yardstick,
+  #   mutant, mutant-rspec
+  gem 'devtools', '~> 0.1.8'
+
+  # Rubocop extensions which reflect BlockScore's style guide
+  gem 'rubocop-devtools', git: 'https://github.com/backus/rubocop-devtools.git'
+
+  # Enforce style and convention for rspec
+  gem 'rubocop-rspec', git: 'https://github.com/nevir/rubocop-rspec.git'
+end

data/Guardfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(/.+\.rb$/) { 'spec' }
+end

data/README.md

@@ -1,12 +1,6 @@
 # Cognito Client
 
-Unofficial Ruby client for the BlockScore Cognito API.
-
-Frankenstein of demo code supplied by BlockScore, and our own stuff. `client.rb` is ours,
-everything else is theirs. The BlockScore code basically just handles the structuring
-of their data models.
-
-Currently in the "make it work" phase of development.
+Unofficial Ruby client for the BlockScore Cognito API. This library was designed using a [command-query separation principle](https://en.wikipedia.org/wiki/Command–query_separation).
 
 ## Installation
 
@@ -22,29 +16,72 @@ And then execute:
 
 ## Usage
 
-Create a client
+### Creating a client
+
+```ruby
+client = Cognito::Client.create(
+  api_key:     'your-api-key',
+  api_secret:  'your-api-secret',
+  uri:         'https://sandbox.cognitohq.com',
+  api_version: '2016-09-01'
+)
+```
+
+### Creating a profile
 
 ```ruby
-client = Cognito::Client.new(api_key: 'API_KEY', api_secret: 'API_SECRET')
+profile = client.create_profile
+```
+
+### Create an identity search with phone and name
 
-# default base URI is https://sandbox.cognitohq.com
-#
-# to set a different API:
-client.base_uri('SOME_NEW_BASE_URI')
+```ruby
+search = client.create_identity_search(
+  profile_id:   profile.data.id,
+  phone_number: '+14151231234',
+  name: { # optional
+    first: 'Leslie',
+    last:  'Knope'
+  }
+)
 ```
 
-Create a Profile:
+### Creating an identity assessment for the search
 
 ```ruby
-profile = client.create_profile!
+assessment = search.create_assessment(
+  phone_number: '+14151231234',
+  name: {
+    first: 'Leslie',
+    last:  'Doe'
+  }
+)
 ```
 
-Initiate a search against a phone number:
+### Traversing the data
+
+The client automatically links the resource relationships allowing you to make calls like:
 
 ```ruby
-profile = client.create_profile!
+search.data.identity_records.first.names.map(&:attributes)
 
-search = client.search!(profile.id, '+14151231234')
+# [
+#   { :first=>"LESLIE", :middle=>"BARBARA", :last=>"KNOPE" },
+#   {:first=>"LESLIE", :middle=>nil, :last=>"KNOPE-WYATT" }
+# ]
+
+```
+
+## Running the test suite
+
+```
+bundle exec rspec
+```
+
+## Running the CI tasks
+
+```
+bundle exec rake ci
 ```
 
 ## License

data/Rakefile

@@ -1,7 +1,5 @@
+# encoding: utf-8
 # frozen_string_literal: true
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
+require 'devtools'
+Devtools.init_rake_tasks

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'cognito'
+require 'cognito/client'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/circle.yml

@@ -0,0 +1,7 @@
+---
+machine:
+  ruby:
+    version: '2.3.1'
+test:
+  override:
+    - bundle exec rake ci

data/cognito.gemspec

@@ -21,16 +21,14 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'rake', '~> 11.2'
-  spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'rubocop', '~> 0.41'
-  spec.add_development_dependency 'timecop', '~> 0.8'
-  spec.add_development_dependency 'rspec-its', '~> 1.2.0'
 
   spec.add_dependency 'abstract_type', '~> 0.0.7'
   spec.add_dependency 'adamantium', '~> 0.2.0'
   spec.add_dependency 'anima', '~> 0.3.0'
   spec.add_dependency 'concord', '~> 0.1.5'
-  spec.add_dependency 'httparty', '~> 0.13'
   spec.add_dependency 'procto', '~> 0.0.3'
+  spec.add_dependency 'ice_nine', '~> 0.11.2'
+
+  spec.add_runtime_dependency 'http', '~> 2.0', '>= 2.0.3'
+  spec.add_runtime_dependency 'addressable', '~> 2.4', '>= 2.4.0'
 end

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 1.0

data/config/errors.yml

@@ -0,0 +1,2 @@
+---
+:messages: []

data/config/flay.yml

@@ -0,0 +1,5 @@
+---
+threshold: 12
+total_score: 198
+lib_dirs:
+- lib

data/config/flog.yml

@@ -0,0 +1,5 @@
+---
+threshold: 17.8
+lib_dirs:
+  - -lib/cog/client/request.rb  # Uses squiggly heredoc
+  - lib

data/config/mutant.yml

@@ -0,0 +1,6 @@
+name: cognito/client
+namespace: Cognito
+since: HEAD~1
+ignore_subjects:
+  - 'Cognito::Client::Document#resolve'
+expect_coverage: 1/1

data/config/reek.yml

@@ -0,0 +1,111 @@
+---
+Attribute:
+  enabled: false
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: false
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: false
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 3
+  overrides:
+    initialize:
+      max_params: 5
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 3
+ModuleInitialize:
+  enabled: true
+  exclude: []
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 2
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+PrimaDonnaMethod:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 2
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 9
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 25
+TooManyStatements:
+  enabled: true
+  exclude:
+  - initialize
+  max_statements: 5
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept:
+  - Inline::C
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  - !ruby/regexp /^_/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept:
+  - _
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []

data/config/rubocop.yml

@@ -0,0 +1,91 @@
+---
+require:
+  - rubocop-rspec
+  - rubocop/devtools
+inherit_gem:
+  rubocop-devtools: config/default.yml
+AllCops:
+  Exclude:
+  - vendor/**/*
+  - db/migrate/*
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+# This ends up being too spammy
+Style/Documentation:
+  Enabled: false
+Style/ExtraSpacing:
+  AllowForAlignment: true
+Metrics/LineLength:
+  Max: 100
+Style/IfUnlessModifier:
+  MaxLineLength: 100
+Style/Next:
+  EnforcedStyle: always
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '[]'
+    '%I': '[]'
+    '%q': '{}'
+    '%Q': '{}'
+    '%r': '{}'
+    '%s': ()
+    '%w': '[]'
+    '%W': '[]'
+    '%x': ()
+Style/TrivialAccessors:
+  ExactNameMatch: false
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Style/SymbolArray:
+  Enabled: true
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+Style/CollectionMethods:
+  Enabled: true
+Style/Send:
+  Enabled: true
+Style/AutoResourceCleanup:
+  Enabled: true
+Style/FirstArrayElementLineBreak:
+  Enabled: true
+Style/FirstHashElementLineBreak:
+  Enabled: true
+Style/FirstMethodArgumentLineBreak:
+  Enabled: true
+Style/FirstMethodParameterLineBreak:
+  Enabled: true
+Style/MultilineArrayBraceLayout:
+  Enabled: true
+Style/MultilineAssignmentLayout:
+  EnforcedStyle: new_line
+  Enabled: true
+Style/MultilineHashBraceLayout:
+  Enabled: true
+Style/MultilineMethodCallBraceLayout:
+  Enabled: true
+Style/MultilineMethodDefinitionBraceLayout:
+  Enabled: true
+Style/OptionHash:
+  Enabled: true
+Style/StringMethods:
+  Enabled: true
+Style/IndentArray:
+  EnforcedStyle: consistent
+Style/IndentHash:
+  EnforcedStyle: consistent
+MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/AlignHash:
+  EnforcedColonStyle: table
+Style/SignalException:
+  EnforcedStyle: semantic
+Style/SingleLineBlockParams:
+  Enabled: false
+RSpec/DescribeClass:
+  Exclude: []
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/VerifiedDoubles:
+  IgnoreSymbolicNames: true