riq 0.9.1 → 1.0.1

data/lib/riq/list.rb

@@ -1,89 +0,0 @@
-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
-    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 lists 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
-
-    # 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
-
-    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
-    # 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
-  end
-end

data/lib/riq/list_item.rb

@@ -1,119 +0,0 @@
-require_relative 'riq_obj'
-using RIQExtensions
-
-module RIQ
-  # A List Item is a row in a List.
-  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
-
-    # @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?
-        "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'] = @field_values.to_raw
-        elsif k['_']
-          pld[k.to_cam] = 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_sym, nil)
-      else
-        @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]
-        @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
-        @name = nil
-        @field_values = {}
-        @account_id = nil
-        @contact_ids = []
-        @modified_date = nil
-        @created_date = nil
-      end
-      self
-    end
-  end
-end

data/lib/riq/list_item_manager.rb

@@ -1,13 +0,0 @@
-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, 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/riq_obj.rb

@@ -1,104 +0,0 @@
-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
-
-    # 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

@@ -1,47 +0,0 @@
-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

@@ -1,29 +0,0 @@
-# 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       = '0.9.1'
-  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

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

data/test/test_account.rb

@@ -1,44 +0,0 @@
-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