riq 1.0.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6763599ea332a7fe04b54aab09334f95b74ddeec
-  data.tar.gz: 165b2617d0f2beb63947893e90c5389c9d62f63e
+  metadata.gz: b20c9ddfd74935d80dcf38e3629e1e8e53962d17
+  data.tar.gz: 5ca2c0a6bf4ea725503de340dfa497e8116a8720
 SHA512:
-  metadata.gz: 959c78bf06de627ce564b1fa1de491219dcd9abab31f523a04207bd8d6658f09da5a764894b00b0e4559b238c722a3c89f26b740bd7c57acc6d12035ce865fa3
-  data.tar.gz: 5722f9d6c18ec6329a7bccdb5a547aee635fb6bf4358f2f9a0e379b4323467dc6ca868faac8959ec5aed77efad3ccec1a7c84dc8d7a52f5cf66e51a05f051b03
+  metadata.gz: e96e96be3db9b502790cac618cb647474843e36408c8bdf0ba53c80e53ab8d5b7b353d4463c84169634349516b0c8ea3599de3b37e6c35c37ce7f10ae648c24f
+  data.tar.gz: bac00f6b2740d67c111392f89739e3c28b5f590f36f2c173c77ab8daa2ccc53d94178add5f5fda513cd9ed8fec26ebb386870c378f0fbe045b77fd39b5f0706d

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm: 
+    - 2.1.2
+install: bundle install
+script: ruby test/tester.rb

data/Gemfile

@@ -1,8 +1,4 @@
 source 'https://rubygems.org'
 gemspec
 
-group :development do
-  gem 'pry'
-end
-
-gem 'httparty', '0.13.3'
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,12 +1,20 @@
-# RelateIQ Ruby SDK
+# RelateIQ Ruby SDK 
+[![Gem Version](https://img.shields.io/gem/v/riq.svg)](http://badge.fury.io/rb/riq)
+[![Build Status](https://img.shields.io/travis/relateiq/ruby-sdk.svg)](https://travis-ci.org/relateiq/ruby-sdk)
+
 
 A full featured API interface for interacting with the [RelateIQ](https://relateiq.com) API. 
 
-## Overview
+## Status
+
+|Badge (click for more info)|Explanation|
+|-|-|
+|[![](https://img.shields.io/badge/documentation-100%25-brightgreen.svg)](http://www.rubydoc.info/gems/riq)|% of methods documented|
+|[![Code Climate](https://img.shields.io/codeclimate/coverage/github/relateiq/ruby-sdk.svg)](https://codeclimate.com/github/relateiq/ruby-sdk/coverage)|% of methods tested|
+|[![Code Climate](https://img.shields.io/codeclimate/github/relateiq/ruby-sdk.svg)](https://codeclimate.com/github/relateiq/ruby-sdk/code)|Overall code quality (4.0 is best)|
+|[![Gemnasium](https://img.shields.io/gemnasium/relateiq/ruby-sdk.svg)](https://gemnasium.com/relateiq/ruby-sdk)|Dependency freshness|
+|[![MIT license](http://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)|What can you use this for?|
 
-<!--[![Gem Version](https://badge.fury.io/rb/riq.svg)](http://badge.fury.io/rb/riq)-->
-[![Gem Version](https://img.shields.io/gem/v/riq.svg)](http://badge.fury.io/rb/riq)
-<!--[![MIT license](http://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)-->
 
 ## Code Examples
 
@@ -30,4 +38,4 @@ A full featured API interface for interacting with the [RelateIQ](https://relate
 ## Helpful Links
 
 * [Full ruby docs](http://www.rubydoc.info/gems/riq)
-* [Examples and API docs](https://api.relateiq.com/#/ruby)
+* [Examples and API docs](https://api.relateiq.com/#/ruby)

data/lib/riq/batch_manager.rb

@@ -44,12 +44,17 @@ module RIQ
     # @return [RIQObject]
     def first
       reset_cache
-      fetch_page.first
+      o = fetch_options.dup
+      self.send(:fetch_options=, {_limit: 1})
+      r = fetch_page.first
+      self.send(:fetch_options=, o)
+      r
     end
 
     # Set fetch options
     # @param opts [Hash] Where values are either strings or arrays
     def fetch_options=(opts = {})
+      # these need to be updated with API changes
       valid_keys = [:_ids, :_start, :_limit, :contactIds, :accountIds, :modifiedDate]
       reset_cache
       options = {}

data/lib/riq/client.rb

@@ -85,6 +85,7 @@ module RIQ
 
     def process_response(resp)
       # pp "processing #{resp}, code: #{resp.code}"
+      # puts resp.parsed_response['name']
       if resp.code == 503
         raise NotImplementedError, 'This function is not currently supported by RelateIQ'
       elsif resp.code == 404 

data/lib/riq/list.rb

@@ -47,7 +47,7 @@ module RIQ
     # @return [Hash, nil] info on the field specified
     def fields(id = nil)
       unless id.nil?
-        @fields.select{|f| f['id'] == id.to_s}.first
+        @fields.select{|f| f[:id] == id.to_s}.first
       else
         @fields
       end

data/riq.gemspec

@@ -1,10 +1,8 @@
 # coding: utf-8
-# lib = File.expand_path('../lib', __FILE__)
-# $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'riq'
-  spec.version       = '1.0.2'
+  spec.version       = '1.1.3'
   spec.authors       = ['David Brownman']
   spec.email         = ['david@relateiq.com']
   spec.homepage      = "https://github.com/relateiq/ruby-sdk"
@@ -12,8 +10,6 @@ Gem::Specification.new do |spec|
   spec.description   = 'Full featured ruby client for interacting with the RelateIQ API'
   spec.license       = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0")
-  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   # 2.0 is min becuase use of refinements
@@ -21,9 +17,11 @@ Gem::Specification.new do |spec|
   # spec.post_install_message = 'The power of relationship intelligence is in your hands!'
 
   # prod dependencies
-  spec.add_dependency 'httparty', '0.13.3'
+  spec.add_dependency 'httparty', '~> 0.13'
 
   # dev dependencies
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  # spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'minitest', '~> 5.4'
 end

data/test/test_account.rb

@@ -1,32 +1,44 @@
 require 'minitest/autorun'
+
 require_relative '../lib/riq'
 
+def create_netflix
+  RIQ.account('54e6542fe4b01ad3b7362bc4')
+end
+
+def create_blank_account
+  RIQ.account
+end
+
+def create_data_account
+  RIQ.account({name: 'Glengarry', field_values: {'0' => 3}})
+end
+
 describe RIQ::Account do
   before do
     RIQ.init
-    # netflix account ID
-    @netflix = RIQ.account('54e6542fe4b01ad3b7362bc4')
-    @a = RIQ.account
-    @dat = RIQ.account({name: 'Glengarry', field_values: {'0' => 3}})
   end
 
   describe '#new' do
     it 'should get account' do
+      @netflix = create_netflix
       @netflix.name.must_equal 'Netflix'
     end
 
     it 'should make blank account' do
+      @a = create_blank_account
       @a.wont_be_nil
     end
 
     it 'should take a data hash' do 
-      @dat = RIQ.account({name: 'David'})
+      @dat = create_data_account
       @dat.name.wont_be_nil
     end
   end
 
   describe '#save' do 
     it 'should create new account' do
+      @a = create_blank_account
       @a.name = 'Delete Test Inc'
       @a.field_value(2, '1')
       @a.save
@@ -37,7 +49,9 @@ describe RIQ::Account do
 
   describe "#field_value" do
     it 'should fetch a field value' do 
+      @netflix = create_netflix
       @netflix.field_value(2).wont_be_nil
+      @dat = create_data_account
       @dat.field_value(0).wont_be_nil
     end
   end

data/test/test_batch_manager.rb

@@ -9,12 +9,13 @@ describe RIQ::BatchManager do
 
   describe '#accounts' do
     it 'should get all accounts' do
+      # could limit this, but want it to make sure the default works
       accounts = RIQ.accounts
       accounts.each do |a|
         a.id.wont_be_nil
         a.name.wont_be_nil
         @c += 1
-        break if @c >= 20
+        break if @c >= 5
       end
       @c.wont_equal 0
     end
@@ -22,11 +23,12 @@ describe RIQ::BatchManager do
 
   describe '#contacts' do 
     it 'should get all contacts' do
-      contacts = RIQ.contacts
+      contacts = RIQ.contacts({_limit: 3})
       contacts.each do |con|
         con.id.wont_be_nil
         @c += 1
-        break if @c >= 20
+        # need to test that it can cycle to the next call
+        break if @c >= 10
       end
       @c.wont_equal 0
     end
@@ -43,7 +45,7 @@ describe RIQ::BatchManager do
         lic = 0
         l.list_items.each do |li|
           lic += 1
-          break if lic >= 5
+          break if lic >= 3
         end
         lic.wont_equal 0
         break if @c >= 20
@@ -58,6 +60,13 @@ describe RIQ::BatchManager do
       c = RIQ.contacts.first
       c.must_be_instance_of RIQ::Contact
     end
+
+    it 'should not change fetch options' do
+      opts = {_limit: 15, _ids: '5550fd35e4b0da744884f69d'}
+      bm = RIQ.contacts(opts)
+      bm.first
+      bm.fetch_options.must_equal bm.fetch_options.merge(opts)
+    end
   end
 
   describe '#fetch_options' do 

data/test/test_contact.rb

@@ -1,27 +1,42 @@
 require 'minitest/autorun'
 require_relative '../lib/riq'
 
+def create_sammy
+  RIQ.contact('542b205be4b04cd81270dff9')
+end
+
+def create_blank_contact
+  RIQ.contact  
+end
+
+def create_data
+  RIQ.contact({properties: {'name' => ['david'], email: ['dab@relateiq.com']}})
+end
+
 describe RIQ::Contact do
   before do
     RIQ.init
-    # sammy's contact ID
-    @sammy = RIQ.contact('542b205be4b04cd81270dff9')
-    @c = RIQ.contact
-    @dat = RIQ.contact({properties: {'name' => ['david'], email: ['dab@relateiq.com']}})
   end
 
   describe '#new' do
     it 'should get account' do
+      @sammy = create_sammy
       @sammy.name.must_include 'Sammy Nammari'
     end
 
-    it 'make blank contact' do
+    it 'should make blank contact' do
+      @c = create_blank_contact
       @c.wont_be_nil
     end
+
+    it 'should take a data hash' do
+      @dat = create_data
+    end
   end
 
   describe '#save' do 
     it 'should create new contact and delete it' do
+      @c = create_blank_contact
       @c.add(:name, 'Ron Mexico')
       @c.save
 
@@ -32,13 +47,15 @@ describe RIQ::Contact do
   end
 
   describe 'properties' do 
-    it 'should add new emails only if they\'re new' do
+    it "should add new emails only if they're new" do
+      @sammy = create_sammy
       @sammy.email.must_equal @sammy.add(:email, 'nammari@stanford.edu')
 
       @sammy.email.wont_equal @sammy.add(:email, 'jammari@stanford.edu')      
     end
 
     it 'should only take strings as properties' do
+      @c = create_blank_contact
       @c.add(:phone, '867-5309').wont_be_empty
 
       begin
@@ -53,6 +70,7 @@ describe RIQ::Contact do
 
   describe '#upsert' do 
     it 'should upsert' do
+      @sammy = create_sammy
       # this could be better
       @sammy.email.must_equal @sammy.upsert.email
 

data/test/test_event.rb

@@ -1,27 +1,35 @@
 require 'minitest/autorun'
 require_relative '../lib/riq'
 
+def create_blank_event
+  RIQ.event
+end
+
+def create_data_event
+  RIQ.event({subject: "My Sub", body: "Bodily harm", 'participantIds' => [{type: :email, value: 'fake@fakerelateiq.com'}]})
+end
+
 describe RIQ::Event do
   before do
     RIQ.init
-    # sammy's contact ID
-    @e = RIQ.event
-    @ev = RIQ.event({subject: "My Sub", body: "Very intersting body", 'participantIds' => [{type: :email, value: 'fake@fakerelateiq.com'}]})
   end
 
   describe '#new' do
     it 'should start blank' do
+      @e = create_blank_event
       @e.subject.must_be_nil
     end
 
     it 'should take a hash' do
+      @ev = create_data_event
       @ev.subject.wont_be_nil
       @ev.participant_ids.wont_be_empty
     end
   end
 
   describe '#save' do
-    it 'should fail without subject'do
+    it 'should fail without subject' do
+      @e = create_blank_event
       begin
         @e.save
       rescue RIQ::HTTPError
@@ -32,18 +40,21 @@ describe RIQ::Event do
     end
 
     it 'should save with data' do 
+      @ev = create_data_event
       @ev.save.must_be_kind_of Hash
     end
   end
 
   describe '#add_participant' do
     it 'should add a participant' do 
+      @e = create_blank_event
       p = {type: :email, value: 'good'}
       @e.add_participant(p[:type], p[:value])
       @e.participant_ids.must_include p
     end
 
     it 'should reject bad types' do
+      @e = create_blank_event
       begin
         @e.add_participant(:blarg, 'bad type')
       rescue RIQ::RIQError

data/test/test_list_item.rb

@@ -1,24 +1,34 @@
 require 'minitest/autorun'
 require_relative '../lib/riq'
 
+def create_blank_list_item
+  @l.list_item
+end
+
+def create_first
+  @l.list_items.first
+end
+
 describe RIQ::ListItem do
   before do
     RIQ.init
     lid = '54ca9b25e4b0b29d80ce4b4e'
     @l = RIQ.list(lid)
-    @li = @l.list_items.first
-    @blank = @l.list_item
   end
 
   describe '#field_value' do
     it 'should return a value' do
+      @li = create_first
       @li.field_value(0).wont_be_nil
+
+      @blank = create_blank_list_item
       @blank.field_value(0).must_be_nil
     end
   end
 
   describe '#save' do
     it 'should create and delete' do
+      @blank = create_blank_list_item
       @blank.field_value(0, 1)
       @blank.contact_ids << RIQ.contacts.first.id
       @blank.save
@@ -28,6 +38,7 @@ describe RIQ::ListItem do
     end
 
     it 'should update' do
+      @li = create_first
       start = @li.field_value(0)
       if start == '1'
         @li.field_value(0, 0)

data/test/tester.rb

@@ -0,0 +1,32 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+# testing!
+require 'vcr'
+
+VCR.configure do |c|
+  # important so the api keys don't matter
+  # need to match body for event cassettes, need to match query for anything with contacts/li/accounts
+  c.default_cassette_options = {match_requests_on: [:method, :path, :query, :body], record: :new_episodes}
+  
+  c.cassette_library_dir = 'vcr_cassettes'
+  c.filter_sensitive_data('<API_KEY>') { ENV['RIQ_TEST_API_KEY'] }
+  c.filter_sensitive_data('<API_SECRET>') { ENV['RIQ_TEST_API_SECRET'] }
+  
+  c.hook_into :webmock
+  c.before_record do |request|
+    # this prevents binary data from being written into the vcr
+    if request.response.body.encoding == Encoding::ASCII_8BIT
+      request.response.body = request.response.body.force_encoding('utf-8')
+    end
+  end
+  # grab them all 
+  # https://stackoverflow.com/questions/16533980/using-specific-vcr-cassette-based-on-request
+  c.around_http_request do |request|
+    VCR.use_cassette('global', &request)
+  end
+end
+
+
+# require everything to run all tests
+Dir["#{__dir__}/*_*.rb"].each{|f| require_relative f}