riq 0.8.3

data/lib/relateiq/contact.rb

@@ -0,0 +1,139 @@
+require_relative 'riq_obj'
+
+module RIQ
+  class Contact < RIQObject
+    attr_accessor :properties
+
+       # (see RIQObject#node)
+    def node
+      self.class.node(@id)
+    end
+
+    # (see RIQObject#node)
+    def self.node(id = nil)
+      "contacts/#{id}"
+    end
+    
+    # (see RIQObject#data)
+    def data
+      {
+        id: @id,
+        properties: @properties
+      }
+    end
+
+    # @!macro [new] prop
+    #   @return [Array] all of the values for $0
+    def name
+      get_prop(:name)
+    end
+
+    # @macro prop
+    def phone
+      get_prop(:phone)
+    end
+
+    # @macro prop
+    def email
+      get_prop(:email)
+    end
+
+    # @macro prop
+    def address
+      get_prop(:address)
+    end
+
+    # Adds property with correct scaffolding
+    # @param prop [Symbol] Type Property to add, such as :name or :email
+    # @param val [String, Array] Value(s) to add
+    # @return [Array] Values for that property after the add
+    def add(prop, val)
+      # validate(prop)
+      prop = prop.to_sym
+      @properties[prop] = [] unless @properties.include? prop
+
+      if val.is_a? Array
+        val.each do |i|
+          add(prop, i)
+        end
+      end
+
+      # don't add duplicate 
+      if @properties[prop].select{|p| p[:value] == val}.empty?
+        @properties[prop] << {value: val, metadata: {}}
+      end
+      send(prop)
+    end
+
+    # Removes property from hash
+    # @param prop [Symbol] Type Property to remove, such as :name or :email
+    # @param val [String, Array] Value(s) to remove
+    # @return [Array] Values for that property after the remove
+    def remove(prop, val)
+      # validate(prop)
+      prop = prop.to_sym
+
+      if val.is_a? Array
+        val.each do |i|
+          remove(prop, i)
+        end
+      end
+
+      if @properties.include? prop
+        @properties[prop] = @properties[prop].reject{|p| p[:value] == val}
+      end
+      send(prop)
+    end
+
+    # Edits an existing object based on matching email(s) or saves a new object
+    # @see RIQObject#save
+    def upsert
+      save({_upsert: 'email'})
+    end
+
+    # @param prop [Symbol] The property to fetch. One of [:name, :phone, :email, :address]
+    # @param val [String] The value to get info on, such as 'name@domain.com'
+    # @return [Hash] metadata and other info about a given property
+    def info(prop, val)
+      # validate(prop)
+
+      @properties[prop].select{|p| p[:value] == val}.first
+    end
+
+    private
+
+    def init(obj = nil)
+      unless obj.nil?
+        @id = obj['id']
+        @properties = symbolize(obj['properties'])
+      else
+        @id = nil
+        @properties = {}
+      end
+      self
+    end
+
+    # unused because we actually put all sorts of stuff in there
+    def validate(prop)
+      raise RIQError, %q(Invalid property. Use [:name | :phone | :email | :address] instead) unless [:name, :phone, :email, :address].include? prop
+    end
+
+    def get_prop(prop)
+      if @properties.include? prop
+        @properties[prop].map{|p| p[:value]}
+      else
+        []
+      end
+    end
+  end
+
+  class << self
+    # 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]
+    def contact(id = nil)
+      Contact.new(id)
+    end
+  end
+end

data/lib/relateiq/error.rb

@@ -0,0 +1,53 @@
+# Base exception class for our errors
+
+module RIQ
+  class RIQError < StandardError
+  end
+
+  class NotImplementedError < RIQError
+  end
+
+  class NotFoundError < RIQError
+  end
+
+  class HTTPError < RIQError
+    attr_accessor :code
+    attr_accessor :message
+    attr_accessor :response
+
+    def initialize(resp)
+      # build response message
+      message = "\n[#{resp.code}] #{resp.message} : "        
+      unless resp.parsed_response.nil?
+        begin
+          m = resp.parsed_response.fetch('errorMessage', 'no message')
+        rescue
+          # parse returned html
+          reg = resp.parsed_response.match(/<pre>(.*)<\/pre>/)
+          unless reg.nil?
+            m = reg[1].strip
+          else
+            m = 'no message'
+          end
+        end
+        message += "<#{m}>"
+      end
+
+      # pull out request info
+      req = resp.request
+      unless req.nil?
+        message += "\n    Request: #{req.http_method} #{req.last_uri.to_s}"
+        unless req.raw_body.nil?
+          message += "\n    #{req.raw_body}"
+        end
+      end
+
+      @message = message
+      @response = resp
+    end
+
+    def to_s
+      @message || super
+    end
+  end
+end

data/lib/relateiq/events.rb

@@ -0,0 +1,104 @@
+# 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
+#   @id = nil
+#   @modifiedDate = nil
+#   @participantIds = nil
+#   @subject = nil
+#   @body = nil
+
+#   def initialize(
+#       _id=nil,
+#       subject=nil,
+#       body=nil,
+#       participantIds=nil,
+#       data:nil,
+#       hash:nil
+#     )
+#     if !data.nil?
+#       parse(data)
+#     elsif !hash.nil?
+#       process_hash(hash)
+#     elsif !id(_id).nil?
+#       Event::get(self)
+#     end
+#     participantIds(participantIds)
+#     subject(subject)
+#     body(body)
+#   end
+
+#   class << self
+#     def node
+#       'events'
+#     end
+
+#     def factory(data = nil, hash = nil)
+#       return Event.new(data, hash)
+#     end
+
+#     def update(instance, options = {})
+#       response = Client::put(self.endpoint(), instance.payload(), options)
+#       return instance
+#     end
+#   end
+
+#   def parse(data)
+#     obj = JSON.parse(data.body)
+#     id(obj['id'])
+#     modifiedDate(obj['modifiedDate'])
+#   end
+
+#   def process_hash(hash)
+#     id(hash['id'])
+#     modifiedDate(hash['modifiedDate'])
+#   end
+
+#   # Data Payload
+#   def payload()
+#     payload = {:participantIds => @participantIds,
+#       :subject => subject(),
+#       :body => body()
+#     }
+#     if modifiedDate() then
+#       payload['modifiedDate'] = modifiedDate()
+#     end
+#     payload['id'] = id() if id()
+#     return payload
+#   end
+
+#   # Hybrid
+#   def id(value = nil)
+#     @id = value unless value.nil?
+#   end
+
+#   def modifiedDate(value = nil)
+#     @modifiedDate = value unless value.nil?
+#   end
+
+#   def subject(value = nil)
+#     @subject = value unless value.nil?
+#   end
+
+#   # value should either be a string or a list of strings
+#   # returns: if multiple values exist for key, a list of strings of values
+#   #          if a single value exists, return the single string value (not in a list)
+#   #          if no values exist, return nil
+#   def participantIds(value = nil)
+#     # set value if passed in
+#     @participantIds = value unless value.nil?
+#   end
+
+#   def body(value=nil)
+#     @body = value unless value.nil?
+#   end
+# end

data/lib/relateiq/list.rb

@@ -0,0 +1,87 @@
+# require_relative 'riq_obj'
+# require_relative 'batch_manager'
+
+module RIQ
+  class List < RIQObject
+    # can't create a list through api, so these don't need to write
+    attr_reader :title
+    attr_reader :type
+    attr_reader :list_items
+    # for consistency
+    alias_method :name, :title
+
+    # (see RIQObject#initialize)
+    def initialize(id = nil)
+      super
+      @list_items = ListItemManager.new(@id)
+    end
+
+    # (see RIQObject#node)
+    def node
+      self.class.node(@id)
+    end
+
+    # (see RIQObject#node)
+    def self.node(id = nil)
+      "lists/#{id}"
+    end
+
+    # (see RIQObject#data)
+    def data
+      {
+        id: @id,
+        title: @title,
+        type: @type,
+        fields: @fields
+      }
+    end
+
+    # Overwriting parent because litsts can't be saved through the API
+    def save
+      raise NotImplementedError, "Lists can't be edited through the API"
+    end
+
+    # Gets field if it exists
+    # @param id [String, Integer] field ID
+    # @return [Hash, nil] info on the field specified
+    def fields(id = nil)
+      unless id.nil?
+        @fields.select{|f| f['id'] == id.to_s}.first
+      else
+        @fields
+      end
+    end
+
+    def list_item(oid = nil)
+      RIQ::ListItem.new(oid, lid: @id)
+    end
+
+    private
+    
+    def init(obj = nil)
+      unless obj.nil?
+        @id = obj['id']
+        @title = obj['title']
+        @type = obj['listType']
+        @fields = obj['fields']
+      else
+        @id = nil
+        @title = nil
+        @type = nil
+        @fields = nil
+      end
+      self
+    end
+  end
+
+  class << self
+    # Convenince 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/relateiq/list_item_manager.rb

@@ -0,0 +1,13 @@
+
+
+module RIQ
+  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/relateiq/listitem.rb

@@ -0,0 +1,115 @@
+
+
+module RIQ
+  class ListItem < RIQObject
+    attr_accessor :name
+    attr_accessor :field_values
+    attr_accessor :account_id
+    attr_accessor :contact_ids
+    attr_accessor :list_id
+
+    attr_reader :modified_date
+    attr_reader :created_date
+
+    def initialize(id = nil, lid: nil)
+      if id.is_a? Hash
+        super(id)
+      elsif id.nil? && lid.nil?
+        super(nil)
+      elsif id.nil? && !lid.nil?
+        super(nil)
+        @list_id = lid
+      elsif id.nil? || lid.nil?
+        raise RIQError, 'ObjectID and List ID are required'
+      else
+        super("#{lid}/listitems/#{id}")
+      end
+    end
+
+    # (see RIQObject#node)
+    def node
+      self.class.node(@list_id, @id)
+    end
+
+    # (see #node)
+    def self.node(lid = nil, oid = nil)
+      # weird workaround for fetching node on init
+      if lid.nil? && !oid.nil?
+        "lists/#{oid}"
+      else  
+        "lists/#{lid || @list_id}/listitems/#{oid}"
+      end
+    end
+
+    # (see RIQObject#data)
+    def data
+      {
+        name: @name,
+        account_id: @account_id,
+        contact_ids: @contact_ids.flatten,
+        id: @id,
+        list_id: @list_id,
+        field_values: @field_values,
+        modified_date: @modified_date
+      }
+    end
+
+    # (see RIQObject#payload)
+    def payload
+      pld = {}
+      data.each do |k, v|
+        if k == :field_values
+          pld['fieldValues'] = to_raw(@field_values)
+        elsif k['_']
+          pld[camel_case(k)] = v
+        else
+          pld[k] = v
+        end
+      end
+      pld.to_json
+    end
+
+    # @overload field_value(key)
+    #   @param key [String, Integer] 
+    #   @return [Array] Value of key
+    # @overload field_value(key, value)
+    #   Sets key to value
+    #   @param key [String, Integer] Key to set
+    #   @param value [#to_s] Sets key to value
+    def field_value(key, value = nil)
+      # 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)
+      else
+        @field_values[key.to_s] = value.to_s
+        {key.to_s => value.to_s}
+      end
+    end
+
+    private
+
+    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']
+      else
+        @id = nil
+        @list_id = nil
+        @name = nil
+        @field_values = {}
+        @account_id = nil
+        @contact_ids = []
+        @modified_date = nil
+        @created_date = nil
+      end
+      self
+    end
+  end
+end