riq 0.8.5 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed36a60cb8ed191a2a696cbb7f3346f0c2e0449a
-  data.tar.gz: 303fe5f58418cfddbdc102e31b54d1ea429dfe6f
+  metadata.gz: 6930e740162006d865dff1417751857418282d91
+  data.tar.gz: 6d8149a2bec6a8a1220ba1314675703c5ce1a599
 SHA512:
-  metadata.gz: d0a6866a3efb4476e3cb894db8749d7aec3a3710e59e9b057de5640ec313c74b6d3e27861c6735089a45564a8deb285b9c5db6583ae5f604aad6f633f187f892
-  data.tar.gz: c2c9514f5517cc9fc87f7f1a14ca855399b1d23f3e2bbc089b122deca1a34e07072ca1b699a6686c76a6cc80db9a3fd80c38e12bca857f6079ee14d404d51557
+  metadata.gz: 51fcceea1524ec5d3430f89ef5914ec76c0880dec883b922d9d8fe8a53f5aa4fc55568c1bdd2413a4c0dc4bb915259d2e25e4cb4ca022060100e4cf876b4bcf3
+  data.tar.gz: 7d5a8ec9ae93455beebddd0a41abadbc6fdc371a53af672b37ea3aab3b567bdaaa6ab456dae5b8055831ef4bd09ffc92f30d4c9da9a7eccd52b56b251872cd63

data/Gemfile

@@ -5,4 +5,4 @@ group :development do
   gem 'pry'
 end
 
-gem 'httparty'
+gem 'httparty', '0.13.3'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 RelateIQ
+
+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,15 @@
+# RelateIQ Ruby SDK
+
+A full featured API interface for interacting with the [RelateIQ](https://relateiq.com) API. 
+
+## Overview
+
+<!--[![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)-->
+
+
+## Helpful Links
+
+* [Full ruby docs](http://www.rubydoc.info/gems/riq)
+* [Examples and API docs](https://api.relateiq.com/#/ruby)

data/lib/riq.rb

@@ -1,3 +1,7 @@
 # Base file from which everything else is included
+Dir[__dir__ + '/riq/*.rb'].each {|file| require file }
 
-Dir[__dir__ + '/riq/*.rb'].each {|file| require file }
+# The namespace from which all magic springs
+module RIQ
+  # Could fetch defaults or something here
+end

data/lib/riq/account.rb

@@ -1,6 +1,7 @@
 require_relative 'riq_obj'
 
 module RIQ
+  # Accounts represent companies (or other entities).
   class Account < RIQObject
     attr_accessor :name
     attr_accessor :field_values
@@ -71,7 +72,7 @@ module RIQ
     # Convenince method to create new Accounts
     # @param id [String, nil] create a blank Account object or 
     #   fetch an existing one by id.
-    # @return [RIQ::Account]
+    # @return [Account]
     def account(id = nil)
       Account.new(id)
     end

data/lib/riq/batch_manager.rb

@@ -1,12 +1,11 @@
 module RIQ
-  # Manages caching and fetching for a certain type of child
+  # Manages caching and fetching for a certain type of child object.
   class BatchManager
+    # @return [Hash] current fetch options
     attr_reader :fetch_options
 
-    # @param klass [RIQObject] The child class that's being fetched, such as {Account} or {ListItem}
+    # @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
-    # @!macro [new] krass
-    #   is a $1
     def initialize(klass, page_length = 200, fetch_options: {})
       @klass = klass
       begin
@@ -23,6 +22,10 @@ module RIQ
     end
 
     # Iterator for each item in the manager. Pass a block to it!
+    # @example
+    #   RIQ.lists.each do |l|
+    #     puts l
+    #   end
     def each(&blok)
       reset_cache
       loop do
@@ -35,12 +38,15 @@ module RIQ
       end
     end
 
-    # @return [@macro klass]
+    # Returns the first child object, mainly used for testing
+    # @return [RIQObject]
     def first
       reset_cache
       fetch_page(0, 1).first
     end
 
+    # Set fetch options
+    # @param opts [Hash] Where values are either strings or arrays
     def fetch_options=(opts = {})
       reset_cache
       options = {}
@@ -56,7 +62,6 @@ module RIQ
     end
 
     private
-
     def next_item
       if @cache_index == @cache.size
         return nil if ![0, @page_length].include? @cache.size
@@ -124,6 +129,7 @@ module RIQ
     end
 
     # these used to be 2 methods, now they're one
+    # not that we ever seem to use them, but they're there
     def batch(objs, mode)
       return_objs = {}
       while objs.size > 0

data/lib/riq/client.rb

@@ -1,7 +1,5 @@
 require 'httparty'
-require 'pry'
 require 'json'
-
 require_relative 'error'
 
 module RIQ
@@ -53,16 +51,15 @@ module RIQ
       request(endpoint, :delete, nil, options)
     end
 
-    def fetch(endpoint = nil, options: {})
-      # i'm not sure why this would return an empty object instead of raising a notfound
-      # or really, why it exists at all
-      # puts "fetching #{endpoint} with options #{options}"
-      # begin
-      get(endpoint, options: options)
-      # rescue NotFoundError
-        # {}
-      # end
-    end
+    # I'm not sure why this would return an empty object instead of raising a notfound
+    # or really, why it exists at all
+    # def fetch(endpoint = nil, options: {})
+    #   begin
+    #     get(endpoint, options: options)
+    #   rescue NotFoundError
+    #     {}
+    #   end
+    # end
 
     private
 
@@ -101,7 +98,6 @@ module RIQ
     # @return [RIQObject] The result of the request
     def process_response(resp)
       # pp "processing #{resp}, code: #{resp.code}"
-      # binding.pry
       if resp.code == 503
         raise NotImplementedError, 'This function is not currently supported by RelateIQ'
       elsif resp.code == 404 
@@ -130,9 +126,7 @@ module RIQ
     # end
   end
 
-  class << self
-    # A singleton client for use by methods in Object.
-    # Always use RIQ.client to retrieve the client object.
+  class << self  
     # @param key [String] RelateIQ API key
     # @param secret [String] RelateIQ API secret
     # @return [RIQ] The module, in case you want it.
@@ -144,6 +138,8 @@ module RIQ
       self
     end
 
+    # Always use RIQ.client to retrieve the client object.
+    # @return [Client] The client object
     def client
       raise RIQError, 'Client not initialized' unless @@client
       @@client

data/lib/riq/contact.rb

@@ -1,15 +1,16 @@
 require_relative 'riq_obj'
 
 module RIQ
+  # Contacts represent people in an Organization’s address book.
   class Contact < RIQObject
     attr_accessor :properties
 
-       # (see RIQObject#node)
+    # (see RIQObject#node)
     def node
       self.class.node(@id)
     end
 
-    # (see RIQObject#node)
+    # (see RIQObject.node)
     def self.node(id = nil)
       "contacts/#{id}"
     end
@@ -131,7 +132,7 @@ module RIQ
     # Convenince method to create new Contacts
     # @param id [String, nil] create a blank Contact object or 
     #   fetch an existing one by id.
-    # @return [RIQ::Contact]
+    # @return [Contact]
     def contact(id = nil)
       Contact.new(id)
     end

data/lib/riq/error.rb

@@ -1,15 +1,17 @@
-# Base exception class for our errors
-
 module RIQ
+  # Base exception class for our errors.
   class RIQError < StandardError
   end
 
+  # Hasn't been implemented yet. Doesn't get used often.
   class NotImplementedError < RIQError
   end
 
+  # Raised when an objectid fetch doesn't return anything.
   class NotFoundError < RIQError
   end
 
+  # Main error that includes info about the request and what went wrong. 
   class HTTPError < RIQError
     attr_accessor :code
     attr_accessor :message
@@ -46,6 +48,7 @@ module RIQ
       @response = resp
     end
 
+    # used to print the error nicely
     def to_s
       @message || super
     end

data/lib/riq/{events.rb → event.rb}

@@ -1,16 +1,74 @@
-# require 'set'
-# require 'json'
-# require_relative 'riq_base'
-
-# # Events.rb
-# # Events represent interactions involving a Contact associated with a List Item.
-# # Instead of appearing as new content in List columns, Events appear in a “Stream view”
-# # associated with the appropriate List Item. If the same Contact is associated
-# # with more than one List Item, then the Event will appear in all relevant Stream views.
-# # For more info visit https://api.relateiq.com/#/ruby
-
-# class Event < RIQBase
-#   # Object Attributes
+require_relative 'riq_obj'
+
+module RIQ
+  # Events represent interactions involving a Contact associated with a List Item. 
+  class Event < RIQObject
+    attr_accessor :subject
+    attr_accessor :body
+    # attr_reader :participant_ids
+
+    # (see RIQObject#node)
+    def node
+      self.class.node
+    end
+
+    # (see RIQObject#node)
+    def self.node
+      "events"
+    end
+    
+    # (see RIQObject#data)
+    def data
+      {
+        subject: @subject,
+        body: @body,
+        participant_ids: @participant_ids
+      }
+    end
+
+    # @param type [Symbol] One of :email or :phone
+    # @param value [String] An email or phone number for the contact
+    def add_participant(type, value)
+      raise RIQError, 'Type must be :email or :phone' unless [:email, :phone].include?(type)
+      @participant_ids << {type: type, value: value}
+    end
+
+    # @return [Array] Immutable copy of participant_ids
+    def participant_ids
+      @participant_ids.dup
+    end
+
+    # @return [Hash] Success message, if successul. 
+    def save
+      # there are no options to pass for event save
+      @client.put(node, payload, options: nil)
+      {status: 204, message: 'No Content'}
+    end
+
+    private
+    def init(obj = nil)
+      unless obj.nil?
+        @subject = obj['subject']
+        @body = obj['body']
+        @participant_ids = obj['participantIds']
+      else
+        @subject = nil
+        @body = nil
+        @participant_ids = []
+      end
+      self
+    end
+  end
+
+  class << self
+    # Convenience method to create new Events
+    # @return [Event]
+    def event
+      Event.new
+    end
+  end
+end
+
 #   @id = nil
 #   @modifiedDate = nil
 #   @participantIds = nil

data/lib/riq/list.rb

@@ -1,7 +1,8 @@
-# require_relative 'riq_obj'
-# require_relative 'batch_manager'
+require_relative 'riq_obj'
 
 module RIQ
+  # A List is an object that can be created and customized by a User to represent 
+  # Accounts (companies) or Contacts (people) in a process (such as a sales pipeline).
   class List < RIQObject
     # can't create a list through api, so these don't need to write
     attr_reader :title
@@ -21,7 +22,7 @@ module RIQ
       self.class.node(@id)
     end
 
-    # (see RIQObject#node)
+    # (see RIQObject.node)
     def self.node(id = nil)
       "lists/#{id}"
     end
@@ -36,7 +37,7 @@ module RIQ
       }
     end
 
-    # Overwriting parent because litsts can't be saved through the API
+    # Overwriting parent because lists can't be saved through the API
     def save
       raise NotImplementedError, "Lists can't be edited through the API"
     end
@@ -52,6 +53,8 @@ module RIQ
       end
     end
 
+    # Convenience method for fetching or creating a listitem from the given list
+    # @param oid [String, nil] ObjectId
     def list_item(oid = nil)
       RIQ::ListItem.new(oid, lid: @id)
     end
@@ -75,13 +78,12 @@ module RIQ
   end
 
   class << self
-    # Convenince method to create new Lists
+    # Convenience method to create new Lists
     # @param id [String, nil] create a blank List object or 
     #   fetch an existing one by id.
     # @return [List]
     def list(id = nil)
       List.new(id)
     end
-    # TODO: could also just have #lists that returns whatever i'm supposed to be returning for my generator
   end
 end

data/lib/riq/list_item_manager.rb

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

data/lib/riq/listitem.rb

@@ -1,6 +1,7 @@
-
+require_relative 'riq_obj'
 
 module RIQ
+  # A List Item is a row in a List.
   class ListItem < RIQObject
     attr_accessor :name
     attr_accessor :field_values
@@ -31,7 +32,9 @@ module RIQ
       self.class.node(@list_id, @id)
     end
 
-    # (see #node)
+    # @note this is the only object for which you have to include two params
+    # @param lid [String] ListId that the lit item belongs to
+    # @param oid [String] ObjectId for the object
     def self.node(lid = nil, oid = nil)
       # weird workaround for fetching node on init
       if lid.nil? && !oid.nil?

data/lib/riq/riq_obj.rb

@@ -1,17 +1,14 @@
-# the objcet from which accounts, lists, items, etc will inherit
-
-require 'pp'
-require 'json'
 require_relative 'client'
 
-
 module RIQ
   # @abstract This class should not be used directly. 
-  #   Instead, use a child such as {Contact} or {Account}.
+  #   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
@@ -22,7 +19,7 @@ module RIQ
           # this looks dumb, could name variables better
           data = @id
         else
-          data = @client.fetch(node)
+          data = @client.get(node)
         end
         init(data)
       else
@@ -36,6 +33,12 @@ module RIQ
       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'
@@ -43,7 +46,15 @@ module RIQ
     
     # @return [String] the json representation of {#data}
     def payload
-      data.to_json
+      pld = {}
+      data.each do |k, v|
+        if k['_']
+          pld[camel_case(k)] = v
+        else
+          pld[k] = v
+        end
+      end
+      pld.to_json
     end
 
     # Creates or updates the object
@@ -57,6 +68,8 @@ module RIQ
       end
     end
 
+    # Deletes the object
+    # @note This is IRREVERSIBLE
     def delete
       @client.delete(node)
     end

data/lib/riq/user.rb

@@ -1,6 +1,7 @@
-# users are things
+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
@@ -33,4 +34,14 @@ module RIQ
       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

@@ -1,11 +1,10 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'riq/version'
+# 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       = RIQ::VERSION
+  spec.version       = '0.8.8'
   spec.authors       = ['David Brownman']
   spec.email         = ['david@relateiq.com']
   spec.homepage      = "https://github.com/relateiq/ruby-sdk"
@@ -21,7 +20,7 @@ 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'
+  spec.add_dependency 'httparty', '0.13.3'
 
   # dev dependencies
   spec.add_development_dependency 'bundler', '~> 1.7'

data/test/test_account.rb

@@ -1,5 +1,5 @@
 require 'minitest/autorun'
-require_relative '../lib/relateiq'
+require_relative '../lib/riq'
 
 describe RIQ::Account do
   before do

data/test/test_batch_manager.rb

@@ -1,5 +1,5 @@
 require 'minitest/autorun'
-require_relative '../lib/relateiq'
+require_relative '../lib/riq'
 
 describe RIQ::BatchManager do
   before do

data/test/test_contact.rb

@@ -1,5 +1,5 @@
 require 'minitest/autorun'
-require_relative '../lib/relateiq'
+require_relative '../lib/riq'
 
 describe RIQ::Contact do
   before do

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: riq
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.8
 platform: ruby
 authors:
 - David Brownman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 0.13.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 0.13.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -48,19 +48,20 @@ files:
 - ".gitignore"
 - ".yardopts"
 - Gemfile
+- LICENSE.txt
+- README.md
 - lib/riq.rb
 - lib/riq/account.rb
 - lib/riq/batch_manager.rb
 - lib/riq/client.rb
 - lib/riq/contact.rb
 - lib/riq/error.rb
-- lib/riq/events.rb
+- lib/riq/event.rb
 - lib/riq/list.rb
 - lib/riq/list_item_manager.rb
 - lib/riq/listitem.rb
 - lib/riq/riq_obj.rb
 - lib/riq/user.rb
-- lib/riq/version.rb
 - riq.gemspec
 - test/test.rb
 - test/test_account.rb
@@ -86,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby RIQ API client

data/lib/riq/version.rb

@@ -1,3 +0,0 @@
-module RIQ
-  VERSION = "0.8.5"
-end