riq 1.0.1 → 1.0.2

data/lib/riq/list_item_manager.rb

@@ -0,0 +1,13 @@
+require_relative 'batch_manager'
+require_relative 'list_item'
+
+module RIQ
+  # Special child for initializing list items, who need to include extra info.
+  class ListItemManager < BatchManager
+    def initialize(lid, opts = {})
+      raise RIQError, 'List id can\'t be nil' if lid.nil?
+      @list_id = lid
+      super(RIQ::ListItem, opts)
+    end
+  end
+end

data/lib/riq/riq_obj.rb

@@ -0,0 +1,105 @@
+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
+
+    # @param id [String, Hash] ObjectId or well-formatted hash of data (usually provided by another object
+    # @return [RIQObject] Self
+    def initialize(id = nil)
+      @client = RIQ.client
+      @id = id
+
+      unless @id.nil?
+        # data hash
+        if @id.is_a? Hash
+          # this looks dumb, could name variables better
+          data = @id
+        else
+          data = @client.get(node)
+        end
+        init(data.symbolize)
+      else
+        init
+      end
+      self
+    end
+
+    # @return [String] endpoint
+    def node
+      raise RIQError, 'This should be overwritten'
+    end
+
+    # @param id [String] ObjectId
+    # @return [String] endpoint
+    def self.node(id = nil)
+      raise RIQError, 'This should be overwritten'
+    end    
+
+    # @return [Hash] all relevant stored data
+    def data
+      raise RIQError, 'This should be overwritten'
+    end
+    
+    # @return [String] the JSON representation of {#data}
+    def payload
+      pld = {}
+      data.each do |k, v|
+        if k['_']
+          pld[k.to_cam] = v
+        else
+          pld[k] = v
+        end
+      end
+      pld.to_json
+    end
+
+    # Creates or updates the object
+    def save(options = nil)
+      if @id.nil?
+        # create
+        init(@client.post(node, payload, options: options).symbolize)
+      else
+        # update
+        init(@client.put(node, payload, options: options).symbolize)
+      end
+    end
+
+    # Deletes the object
+    # @note This is IRREVERSIBLE
+    def delete
+      @client.delete(node)
+    end
+
+    # can't decide how I want objects displayed
+    # when you print the object
+    # def to_s
+      # JSON.pretty_generate(data)
+      # data
+    # end
+
+    # When the object itself is called or returned
+    # def inspect
+      # data
+    # end
+
+    private
+    def init
+      raise RIQError, 'This should be overwritten'
+    end
+
+    # def exists
+    #   if @id.nil?
+    #     false
+    #   else
+    #     @client.fetch(node)
+    #   end
+    # end
+  end
+end

data/lib/riq/user.rb

@@ -0,0 +1,47 @@
+require_relative 'riq_obj'
+
+module RIQ
+  # Users are represented by owners and contacts in your RelateIQ organization
+  class User < RIQObject
+    attr_accessor :name
+    attr_accessor :email
+
+    # (see RIQObject#node)
+    def node
+      "users/#{@id}"
+    end
+
+    # (see RIQObject#data)
+    def data
+      {
+        id: @id,
+        name: @name,
+        email: @email
+      }
+    end
+    
+    private
+    def init(obj = nil)
+      unless obj.nil?
+        @id = obj[:id]
+        @name = obj[:name]
+        @email = obj[:email]
+      else
+        @id = nil
+        @name = nil
+        @email = nil
+      end
+      self
+    end
+  end
+
+  class << self
+    # Convenience method to create new Users
+    # @param id [String, nil] create a blank User object or 
+    #   fetch an existing one by id.
+    # @return [User]
+    def user(id = nil)
+      RIQ::User.new(id)
+    end
+  end
+end

data/riq.gemspec

@@ -0,0 +1,29 @@
+# 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.authors       = ['David Brownman']
+  spec.email         = ['david@relateiq.com']
+  spec.homepage      = "https://github.com/relateiq/ruby-sdk"
+  spec.summary       = 'Ruby RIQ API client'
+  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
+  spec.required_ruby_version = '>= 2.0.0'
+  # spec.post_install_message = 'The power of relationship intelligence is in your hands!'
+
+  # prod dependencies
+  spec.add_dependency 'httparty', '0.13.3'
+
+  # dev dependencies
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  # spec.add_development_dependency 'rake', '~> 10.0'
+end

data/test/test.rb

@@ -0,0 +1,4 @@
+# testing!
+
+# require everything to run all tests
+Dir["#{__dir__}/*_*.rb"].each{|f| require_relative f}

data/test/test_account.rb

@@ -0,0 +1,44 @@
+require 'minitest/autorun'
+require_relative '../lib/riq'
+
+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.name.must_equal 'Netflix'
+    end
+
+    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 
+    it 'should create new account' do
+      @a.name = 'Delete Test Inc'
+      @a.field_value(2, '1')
+      @a.save
+
+      @a.id.wont_be_nil
+    end
+  end
+
+  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
+end

data/test/test_batch_manager.rb

@@ -0,0 +1,72 @@
+require 'minitest/autorun'
+require_relative '../lib/riq'
+
+describe RIQ::BatchManager do
+  before do
+    RIQ.init
+    @c = 0
+  end
+
+  describe '#accounts' do
+    it 'should get all accounts' 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
+      @c.wont_equal 0
+    end
+  end
+
+  describe '#contacts' do 
+    it 'should get all contacts' do
+      contacts = RIQ.contacts
+      contacts.each do |con|
+        con.id.wont_be_nil
+        @c += 1
+        break if @c >= 20
+      end
+      @c.wont_equal 0
+    end
+  end
+
+  describe '#lists' do
+    it 'should get all lists' 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({_ids: ['53a0bc44e4b0d7993870bcf4','5550fd35e4b0da744884f69d']})
+      b.each do |i|
+        @c += 1
+      end
+      @c.must_equal 2
+    end
+  end
+end

data/test/test_contact.rb

@@ -0,0 +1,62 @@
+require 'minitest/autorun'
+require_relative '../lib/riq'
+
+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.name.must_include 'Sammy Nammari'
+    end
+
+    it 'make blank contact' do
+      @c.wont_be_nil
+    end
+  end
+
+  describe '#save' do 
+    it 'should create new contact and delete it' do
+      @c.add(:name, 'Ron Mexico')
+      @c.save
+
+      @c.id.wont_be_nil
+
+      assert(@c.delete)
+    end
+  end
+
+  describe 'properties' do 
+    it 'should add new emails only if they\'re new' do
+      @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.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 
+    it 'should upsert' do
+      # this could be better
+      @sammy.email.must_equal @sammy.upsert.email
+
+      # should add another assertion with the blank contact
+    end
+  end
+end

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