riq 0.8.8 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6930e740162006d865dff1417751857418282d91
-  data.tar.gz: 6d8149a2bec6a8a1220ba1314675703c5ce1a599
+  metadata.gz: 298db01f6539c6549b61843f84e90c13e3392c44
+  data.tar.gz: cf5dd577bd23f093e1112504a7713ced7da69e73
 SHA512:
-  metadata.gz: 51fcceea1524ec5d3430f89ef5914ec76c0880dec883b922d9d8fe8a53f5aa4fc55568c1bdd2413a4c0dc4bb915259d2e25e4cb4ca022060100e4cf876b4bcf3
-  data.tar.gz: 7d5a8ec9ae93455beebddd0a41abadbc6fdc371a53af672b37ea3aab3b567bdaaa6ab456dae5b8055831ef4bd09ffc92f30d4c9da9a7eccd52b56b251872cd63
+  metadata.gz: b491d52bd9c27e4c6f9873b24888d4037492b4e20cf90fb9e005b82642caf0003deccc7b017b4971dd48905dcbeedb47adf776d553b60f8def3046ad740d87f2
+  data.tar.gz: 7ecd4d753690f5d1661357a65bf49490a0d09fd1592067df167bce4f833ec25297551658b37de7f467801ce80d2e64e5fe8288d53b3dea8b254c08e7d04d3c01

data/lib/riq.rb

@@ -1,7 +1,103 @@
-# Base file from which everything else is included
-Dir[__dir__ + '/riq/*.rb'].each {|file| require file }
-
 # The namespace from which all magic springs
 module RIQ
   # Could fetch defaults or something here
-end
+end
+
+# Monekypatches
+# cry about it, nerd
+module RIQExtensions
+  refine Symbol do
+    def to_cam
+      temp = self.to_s.split('_').map(&:capitalize).join
+      (temp[0].downcase + temp[1..-1]).to_sym
+    end
+
+    def to_snake
+      a = self.to_s.split('')
+      n = []
+      a.each do |l|
+        n << '_' if l.is_upper?
+        n << l.downcase
+      end
+      n = n[1..-1] if n.first == '_'
+      n.join.to_sym
+    end
+  end 
+
+  refine String do
+    def is_upper?
+      !self[/[A-Z]/].nil? && self.length == 1
+    end
+
+    def is_lower?
+      !self[/[a-z]/].nil? && self.length == 1
+    end
+  end
+
+  refine Fixnum do
+    def cut_milis
+      self.to_s[0...-3].to_i
+    end
+
+    def to_sym
+      self.to_s.to_sym
+    end
+  end
+
+  refine Hash do
+    # Converts to RIQ API's [{raw: "VALUE"}] format
+    def to_raw
+      return {} if self.empty?
+      o = {}
+      self.each do |k, v|
+        o[k.to_cam] = [{raw: v}]
+      end
+      o
+    end
+
+    # Converts from RIQ API's [{raw: "VALUE"}] format
+    def from_raw
+      return {} if self.empty?
+      o = {}
+      self.each do |k,v| 
+        if v.is_a?(Array) && v.first.include?(:raw)
+          o[k.to_sym.to_snake] = v.first[:raw]
+        else
+          o[k.to_sym.to_snake] = v
+        end
+      end
+      o
+    end
+
+    def to_cam
+      o = {}
+      self.each do |k,v|
+        o[k.to_cam] = v
+      end
+      o
+    end
+  end
+
+  refine Object do
+    def symbolize
+      return self unless self.respond_to? :keys
+      o = {}
+      self.each do |k, v|
+        if v.respond_to? :keys
+          o[k.to_sym.to_snake] = v.symbolize
+        else
+          if v.respond_to? :each
+            v.map! do |i|
+              i.symbolize
+            end
+          end
+          o[k.to_sym.to_snake] = v
+        end
+      end
+      o
+    end
+  end
+end
+
+# Base file from which everything else is included
+Dir[__dir__ + '/riq/*.rb'].each {|file| require file }

data/lib/riq/account.rb

@@ -1,4 +1,5 @@
 require_relative 'riq_obj'
+using RIQExtensions
 
 module RIQ
   # Accounts represent companies (or other entities).
@@ -29,7 +30,7 @@ module RIQ
     def payload
       # TODO: find more elegant way to do this
       pld = data
-      pld['fieldValues'] = to_raw(@field_values)
+      pld['fieldValues'] = @field_values.to_raw
       pld.delete(:field_values)
       pld.to_json
     end
@@ -45,19 +46,20 @@ module RIQ
       # TODO: double check that this works with arrays of stuff
       # or, have a format function that casts ints to string on save
       if value.nil?
-        @field_values.fetch(key.to_s, nil)
+        @field_values.fetch(key.to_sym, nil)
       else
-        @field_values[key.to_s] = value.to_s
-        {key.to_s => value.to_s}
+        @field_values[key.to_sym] = value.to_s
+        {key.to_sym => value.to_s}
       end
     end
 
     private
     def init(obj = nil)
       unless obj.nil?
-        @id = obj['id']
-        @name = obj['name']
-        @field_values = from_raw(obj['fieldValues'])
+        @id = obj[:id]
+        @name = obj[:name]
+        @field_values = obj[:field_values] ? obj[:field_values].from_raw : {}
+        @modified_date = obj[:modified_date].cut_milis if obj[:modified_date]
       else
         @id = nil
         @name = nil

data/lib/riq/batch_manager.rb

@@ -1,3 +1,5 @@
+using RIQExtensions
+
 module RIQ
   # Manages caching and fetching for a certain type of child object.
   class BatchManager
@@ -6,7 +8,8 @@ module RIQ
 
     # @param klass [RIQObject] The child class that's being fetched, such as {Account} or {List}
     # @param page_length [Integer] The number of items per page
-    def initialize(klass, page_length = 200, fetch_options: {})
+    # @param opts [Hash] fetch options
+    def initialize(klass, page_length = 200, opts: {})
       @klass = klass
       begin
         raise unless @klass.ancestors.include? RIQ::RIQObject
@@ -17,7 +20,7 @@ module RIQ
       reset_cache
       # ruby says that nil is an argument and page_size was getting set to 0
       @page_length = page_length.nil? ? 200 : page_length
-      @fetch_options = fetch_options
+      self.send(:fetch_options=, opts)
       @client = RIQ.client
     end
 
@@ -58,11 +61,12 @@ module RIQ
           options[k] = v
         end
       end
-      @fetch_options = options
+      @fetch_options = options#.to_cam
     end
 
     private
     def next_item
+      # I believe this is resetting opts somehow/not respecting limit
       if @cache_index == @cache.size
         return nil if ![0, @page_length].include? @cache.size
         # puts "\n=== fetching page! (#{@page_index}) (#{@page_length})"

data/lib/riq/contact.rb

@@ -1,4 +1,5 @@
 require_relative 'riq_obj'
+using RIQExtensions
 
 module RIQ
   # Contacts represent people in an Organization’s address book.
@@ -20,6 +21,7 @@ module RIQ
       {
         id: @id,
         properties: @properties
+        # modified_date: @modified_date
       }
     end
 
@@ -57,8 +59,11 @@ module RIQ
         val.each do |i|
           add(prop, i)
         end
+        return
       end
 
+      raise RIQError, 'Values must be strings' unless val.is_a? String
+
       # don't add duplicate 
       if @properties[prop].select{|p| p[:value] == val}.empty?
         @properties[prop] << {value: val, metadata: {}}
@@ -105,8 +110,21 @@ module RIQ
 
     def init(obj = nil)
       unless obj.nil?
-        @id = obj['id']
-        @properties = symbolize(obj['properties'])
+        @id = obj[:id]
+        @modified_date = obj[:modified_date].cut_milis if obj[:modified_date]
+        @properties = {}
+        obj[:properties].each do |k,v|
+          raise RIQError, "Properties must be arrays, #{k} wasn't" if !v.is_a?(Array)
+
+          v.each do |i|
+            unless i.is_a?(Hash)
+              add(k, i)
+            else
+              @properties[k] = [] unless @properties.include?(k)
+              @properties[k] << i
+            end
+          end
+        end
       else
         @id = nil
         @properties = {}

data/lib/riq/event.rb

@@ -1,4 +1,5 @@
 require_relative 'riq_obj'
+using RIQExtensions
 
 module RIQ
   # Events represent interactions involving a Contact associated with a List Item. 
@@ -48,9 +49,10 @@ module RIQ
     private
     def init(obj = nil)
       unless obj.nil?
-        @subject = obj['subject']
-        @body = obj['body']
-        @participant_ids = obj['participantIds']
+        @subject = obj[:subject]
+        @body = obj[:body]
+        @participant_ids = []
+        obj[:participant_ids].each{|o| add_participant(o[:type], o[:value])}
       else
         @subject = nil
         @body = nil
@@ -62,9 +64,10 @@ module RIQ
 
   class << self
     # Convenience method to create new Events
+    # @param obj [Hash] Info to parse into event
     # @return [Event]
-    def event
-      Event.new
+    def event(obj = nil)
+      Event.new(obj)
     end
   end
 end

data/lib/riq/list.rb

@@ -63,10 +63,10 @@ module RIQ
     
     def init(obj = nil)
       unless obj.nil?
-        @id = obj['id']
-        @title = obj['title']
-        @type = obj['listType']
-        @fields = obj['fields']
+        @id = obj[:id]
+        @title = obj[:title]
+        @type = obj[:listType]
+        @fields = obj[:fields]
       else
         @id = nil
         @title = nil

data/lib/riq/{listitem.rb → list_item.rb}

@@ -1,4 +1,5 @@
 require_relative 'riq_obj'
+using RIQExtensions
 
 module RIQ
   # A List Item is a row in a List.
@@ -62,9 +63,9 @@ module RIQ
       pld = {}
       data.each do |k, v|
         if k == :field_values
-          pld['fieldValues'] = to_raw(@field_values)
+          pld['fieldValues'] = @field_values.to_raw
         elsif k['_']
-          pld[camel_case(k)] = v
+          pld[k.to_cam] = v
         else
           pld[k] = v
         end
@@ -83,10 +84,10 @@ module RIQ
       # TODO: double check that this works with arrays of stuff
       # or, have a format function that casts ints to string on save
       if value.nil?
-        @field_values.fetch(key.to_s, nil)
+        @field_values.fetch(key.to_sym, nil)
       else
-        @field_values[key.to_s] = value.to_s
-        {key.to_s => value.to_s}
+        @field_values[key.to_sym] = value.to_s
+        {key.to_sym => value.to_s}
       end
     end
 
@@ -94,14 +95,14 @@ module RIQ
 
     def init(obj = nil)
       unless obj.nil?
-        @id = obj['id']
-        @list_id = obj['listId']
-        @name = obj['name']
-        @field_values = from_raw(obj['fieldValues'])
-        @account_id = obj['accountId']
-        @contact_ids = obj['contactIds']
-        @modified_date = obj['modifiedDate']
-        @created_date = obj['creaetedDate']
+        @id = obj[:id]
+        @list_id = obj[:list_id]
+        @name = obj[:name]
+        @field_values = obj[:field_values] ? obj[:field_values].from_raw : {}
+        @account_id = obj[:account_id]
+        @contact_ids = obj[:contact_ids] || []
+        @modified_date = obj[:modified_date].cut_milis if obj[:modified_date]
+        @created_date = obj[:creaeted_date].cut_milis if obj[:creaeted_date]
       else
         @id = nil
         @list_id = nil

data/lib/riq/list_item_manager.rb

@@ -1,4 +1,5 @@
 require_relative 'batch_manager'
+require_relative 'list_item'
 
 module RIQ
   # Special child for initializing list items, who need to include extra info.

data/lib/riq/riq_obj.rb

@@ -1,11 +1,14 @@
 require_relative 'client'
+using RIQExtensions
 
 module RIQ
   # @abstract This class should not be used directly. 
   #   Instead, use a child such as {Contact} or {List}.
   class RIQObject
+    
+
     attr_accessor :id
-    # attr_reader :modified_date
+    attr_reader :modified_date
 
     # @param id [String, Hash] ObjectId or well-formatted hash of data (usually provided by another object
     # @return [RIQObject] Self
@@ -21,7 +24,7 @@ module RIQ
         else
           data = @client.get(node)
         end
-        init(data)
+        init(data.symbolize)
       else
         init
       end
@@ -49,7 +52,7 @@ module RIQ
       pld = {}
       data.each do |k, v|
         if k['_']
-          pld[camel_case(k)] = v
+          pld[k.to_cam] = v
         else
           pld[k] = v
         end
@@ -61,10 +64,10 @@ module RIQ
     def save(options = nil)
       if @id.nil?
         # create
-        init(@client.post(node, payload, options: options))
+        init(@client.post(node, payload, options: options).symbolize)
       else
         # update
-        init(@client.put(node, payload, options: options))
+        init(@client.put(node, payload, options: options).symbolize)
       end
     end
 
@@ -90,51 +93,6 @@ module RIQ
       raise RIQError, 'This should be overwritten'
     end
 
-    # Converts to RIQ API's [{raw: "VALUE"}] format
-    def to_raw(hsh)
-      return {} if hsh.empty?
-      obj = {}
-      hsh.each do |k, v|
-        obj[k] = [{raw: v}]
-      end
-      obj
-    end
-
-    # Converts from RIQ API's [{raw: "VALUE"}] format
-    def from_raw(hsh)
-      return {} if hsh.empty?
-      obj = {}
-      hsh.each do |k,v| 
-        obj[k] = v.first['raw']
-      end
-      obj
-    end
-
-    def camel_case(sym)
-      temp = sym.to_s.split('_').map(&:capitalize).join
-      temp[0].downcase + temp[1..-1]
-    end
-
-    # make everything a symbol
-    def symbolize(h)
-      return h unless h.respond_to? :keys
-      
-      obj = {}
-      h.each do |k, v|
-        if v.respond_to? :keys
-          obj[k.to_sym] = symbolize(v)
-        else
-          if v.respond_to? :each
-            v.map! do |i|
-              symbolize(i)
-            end
-          end
-          obj[k.to_sym] = v
-        end
-      end
-      obj
-    end
-
     # def exists
     #   if @id.nil?
     #     false
@@ -142,14 +100,5 @@ module RIQ
     #     @client.fetch(node)
     #   end
     # end
-
   end
-
-  # Monkeypatches
-  # class Symbol
-  #   def camel_case
-  #     temp = self.to_s.split('_').map(&:capitalize).join
-  #     temp[0].downcase + temp[1..-1]
-  #   end
-  # end  
 end

data/lib/riq/user.rb

@@ -23,9 +23,9 @@ module RIQ
     private
     def init(obj = nil)
       unless obj.nil?
-        @id = obj['id']
-        @name = obj['name']
-        @email = obj['email']
+        @id = obj[:id]
+        @name = obj[:name]
+        @email = obj[:email]
       else
         @id = nil
         @name = nil

data/riq.gemspec

@@ -4,7 +4,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'riq'
-  spec.version       = '0.8.8'
+  spec.version       = '0.9.1'
   spec.authors       = ['David Brownman']
   spec.email         = ['david@relateiq.com']
   spec.homepage      = "https://github.com/relateiq/ruby-sdk"
@@ -16,7 +16,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 1.9.3'
+  # 2.0 is min becuase use of refinements
+  spec.required_ruby_version = '>= 2.0.0'
   # spec.post_install_message = 'The power of relationship intelligence is in your hands!'
 
   # prod dependencies

data/test/test.rb

@@ -1,4 +1,4 @@
 # testing!
 
 # require everything to run all tests
-Dir["#{File.dirname(__FILE__)}/*.rb"].each{|file| require_relative file.split('/').last}
+Dir["#{__dir__}/*_*.rb"].each{|f| require_relative f}

data/test/test_account.rb

@@ -7,6 +7,7 @@ describe RIQ::Account do
     # netflix account ID
     @netflix = RIQ.account('54e6542fe4b01ad3b7362bc4')
     @a = RIQ.account
+    @dat = RIQ.account({name: 'Glengarry', field_values: {'0' => 3}})
   end
 
   describe '#new' do
@@ -14,9 +15,14 @@ describe RIQ::Account do
       @netflix.name.must_equal 'Netflix'
     end
 
-    it 'make blank account' do
+    it 'should make blank account' do
       @a.wont_be_nil
     end
+
+    it 'should take a data hash' do 
+      @dat = RIQ.account({name: 'David'})
+      @dat.name.wont_be_nil
+    end
   end
 
   describe '#save' do 
@@ -32,8 +38,7 @@ describe RIQ::Account do
   describe "#field_value" do
     it 'should fetch a field value' do 
       @netflix.field_value(2).wont_be_nil
+      @dat.field_value(0).wont_be_nil
     end
   end
-
-  # TODO: get all accounts
 end

data/test/test_batch_manager.rb

@@ -12,6 +12,7 @@ describe RIQ::BatchManager do
       accounts = RIQ.accounts
       accounts.each do |a|
         a.id.wont_be_nil
+        a.name.wont_be_nil
         @c += 1
         break if @c >= 20
       end
@@ -36,10 +37,36 @@ describe RIQ::BatchManager do
       lists = RIQ.lists
       lists.each do |l|
         l.id.wont_be_nil
+        l.title.wont_be_nil
+        l.fields.wont_be_nil
         @c += 1
+        lic = 0
+        l.list_items.each do |li|
+          lic += 1
+          break if lic >= 5
+        end
+        lic.wont_equal 0
         break if @c >= 20
       end
       @c.wont_equal 0
     end
   end
+
+  describe '#first' do 
+    it 'should get one contact' do
+      c = nil
+      c = RIQ.contacts.first
+      c.must_be_instance_of RIQ::Contact
+    end
+  end
+
+  # describe '#fetch_options' do 
+  #   it 'should respect limits' do 
+  #     b = RIQ.contacts(opts: {_limit: 3})
+  #     b.each do |i|
+  #       @c += 1
+  #     end
+  #     @c.must_equal 3
+  #   end
+  # end
 end

data/test/test_contact.rb

@@ -7,6 +7,7 @@ describe RIQ::Contact do
     # 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
@@ -22,7 +23,6 @@ describe RIQ::Contact do
   describe '#save' do 
     it 'should create new contact and delete it' do
       @c.add(:name, 'Ron Mexico')
-      # @c.field_value(2, '1')
       @c.save
 
       @c.id.wont_be_nil
@@ -37,6 +37,18 @@ describe RIQ::Contact do
 
       @sammy.email.wont_equal @sammy.add(:email, 'jammari@stanford.edu')      
     end
+
+    it 'should only take strings as properties' do
+      @c.add(:phone, '867-5309').wont_be_empty
+
+      begin
+        @c.add(:name, {value: 'Jenny'})
+      rescue RIQ::RIQError
+        nil.must_be_nil
+      else
+        1.must_be_nil
+      end
+    end
   end
 
   describe '#upsert' do 

data/test/test_event.rb

@@ -0,0 +1,56 @@
+require 'minitest/autorun'
+require_relative '../lib/riq'
+
+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.subject.must_be_nil
+    end
+
+    it 'should take a hash' do
+      @ev.subject.wont_be_nil
+      @ev.participant_ids.wont_be_empty
+    end
+  end
+
+  describe '#save' do
+    it 'should fail without subject'do
+      begin
+        @e.save
+      rescue RIQ::HTTPError
+        nil.must_be_nil
+      else
+        1.must_be_nil
+      end
+    end
+
+    it 'should save with data' do 
+      @ev.save.must_be_kind_of Hash
+    end
+  end
+
+  describe '#add_participant' do
+    it 'should add a participant' do 
+      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
+      begin
+        @e.add_participant(:blarg, 'bad type')
+      rescue RIQ::RIQError
+        nil.must_be_nil
+      else
+        1.must_be_nil
+      end
+    end
+  end
+end

data/test/test_list_item.rb

@@ -0,0 +1,42 @@
+require 'minitest/autorun'
+require_relative '../lib/riq'
+
+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.field_value(0).wont_be_nil
+      @blank.field_value(0).must_be_nil
+    end
+  end
+
+  describe '#save' do
+    it 'should create and delete' do
+      @blank.field_value(0, 1)
+      @blank.contact_ids << RIQ.contacts.first.id
+      @blank.save
+      @blank.id.wont_be_nil
+
+      assert(@blank.delete)
+    end
+
+    it 'should update' do
+      start = @li.field_value(0)
+      if start == '1'
+        @li.field_value(0, 0)
+      else
+        @li.field_value(0, 1)
+      end
+      @li.save
+
+      @li.field_value(0).wont_equal start
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riq
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.9.1
 platform: ruby
 authors:
 - David Brownman
@@ -58,8 +58,8 @@ files:
 - lib/riq/error.rb
 - lib/riq/event.rb
 - lib/riq/list.rb
+- lib/riq/list_item.rb
 - lib/riq/list_item_manager.rb
-- lib/riq/listitem.rb
 - lib/riq/riq_obj.rb
 - lib/riq/user.rb
 - riq.gemspec
@@ -67,6 +67,8 @@ files:
 - test/test_account.rb
 - test/test_batch_manager.rb
 - test/test_contact.rb
+- test/test_event.rb
+- test/test_list_item.rb
 homepage: https://github.com/relateiq/ruby-sdk
 licenses:
 - MIT
@@ -79,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -87,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby RIQ API client
@@ -96,4 +98,6 @@ test_files:
 - test/test_account.rb
 - test/test_batch_manager.rb
 - test/test_contact.rb
+- test/test_event.rb
+- test/test_list_item.rb
 has_rdoc: