riq 0.9.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 298db01f6539c6549b61843f84e90c13e3392c44
-  data.tar.gz: cf5dd577bd23f093e1112504a7713ced7da69e73
+  metadata.gz: 2e861c8df701fcf3bc680f3061da48295ab332d2
+  data.tar.gz: 27ab3509e83f59d86fd018b0a6f9f852812d8e75
 SHA512:
-  metadata.gz: b491d52bd9c27e4c6f9873b24888d4037492b4e20cf90fb9e005b82642caf0003deccc7b017b4971dd48905dcbeedb47adf776d553b60f8def3046ad740d87f2
-  data.tar.gz: 7ecd4d753690f5d1661357a65bf49490a0d09fd1592067df167bce4f833ec25297551658b37de7f467801ce80d2e64e5fe8288d53b3dea8b254c08e7d04d3c01
+  metadata.gz: 1f5c66f3151336e1e93d6e56170a7aaedabf1c1140fb8b888f0a421952d247c2e2863004d3f5766e33c72e4d06d84dbe743179e26447fe11e1edb91ac591fa08
+  data.tar.gz: 240b0c53d2bae6c5ed73a169721cef3b51bf72e27ddf15e5e68ca48d1940e107a429cce1a959e111901e65baf8cb439c343caa9b810b09870ae544e65df30fd7

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riq
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.1
 platform: ruby
 authors:
 - David Brownman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -44,31 +44,7 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-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/event.rb
-- lib/riq/list.rb
-- lib/riq/list_item.rb
-- lib/riq/list_item_manager.rb
-- lib/riq/riq_obj.rb
-- lib/riq/user.rb
-- riq.gemspec
-- test/test.rb
-- test/test_account.rb
-- test/test_batch_manager.rb
-- test/test_contact.rb
-- test/test_event.rb
-- test/test_list_item.rb
+files: []
 homepage: https://github.com/relateiq/ruby-sdk
 licenses:
 - MIT
@@ -93,11 +69,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby RIQ API client
-test_files:
-- test/test.rb
-- test/test_account.rb
-- test/test_batch_manager.rb
-- test/test_contact.rb
-- test/test_event.rb
-- test/test_list_item.rb
+test_files: []
 has_rdoc: 

data/.gitignore

@@ -1,42 +0,0 @@
-# Created by https://www.gitignore.io
-
-### Ruby ###
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-Gemfile.lock
-
-## Environment normalisation:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# test file
-t.rb

data/.yardopts

@@ -1,2 +0,0 @@
-lib/**/*.rb
---title RelateIQ

data/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-group :development do
-  gem 'pry'
-end
-
-gem 'httparty', '0.13.3'

data/LICENSE.txt

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

@@ -1,15 +0,0 @@
-# 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,103 +0,0 @@
-# The namespace from which all magic springs
-module RIQ
-  # Could fetch defaults or something here
-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,82 +0,0 @@
-require_relative 'riq_obj'
-using RIQExtensions
-
-module RIQ
-  # Accounts represent companies (or other entities).
-  class Account < RIQObject
-    attr_accessor :name
-    attr_accessor :field_values
-
-    # (see RIQObject#node)
-    def node
-      "accounts/#{@id}"
-    end
-
-    # (see #node)
-    def self.node(arg = nil)
-      "accounts"
-    end
-
-    # (see RIQObject#data)
-    def data
-      {
-        id: @id,
-        name: @name,
-        field_values: @field_values
-      }
-    end
-
-    # (see RIQObject#payload)
-    def payload
-      # TODO: find more elegant way to do this
-      pld = data
-      pld['fieldValues'] = @field_values.to_raw
-      pld.delete(:field_values)
-      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]
-        @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
-        @field_values = {}
-      end
-      self
-    end
-
-  end
-
-  class << self
-    # Convenince method to create new Accounts
-    # @param id [String, nil] create a blank Account object or 
-    #   fetch an existing one by id.
-    # @return [Account]
-    def account(id = nil)
-      Account.new(id)
-    end
-  end
-end

data/lib/riq/batch_manager.rb

@@ -1,197 +0,0 @@
-using RIQExtensions
-
-module RIQ
-  # 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 {List}
-    # @param page_length [Integer] The number of items per page
-    # @param opts [Hash] fetch options
-    def initialize(klass, page_length = 200, opts: {})
-      @klass = klass
-      begin
-        raise unless @klass.ancestors.include? RIQ::RIQObject
-      rescue
-        raise RIQError, 'Must pass a RIQ Class'
-      end
-
-      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
-      self.send(:fetch_options=, opts)
-      @client = RIQ.client
-    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
-        x = next_item
-        if x
-          blok.call(x)
-        else
-          return
-        end
-      end
-    end
-
-    # 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 = {}
-      opts.each do |k, v|
-        # some args are comma-separated arrays, some are just args
-        if v.is_a? Array
-          options[k] = v.join(',')
-        else
-          options[k] = v
-        end
-      end
-      @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})"
-        @cache = fetch_page(@page_index, @page_length)
-        @page_index += @cache.size
-        @cache_index = 0
-      end
-
-      if @cache_index < @cache.size
-        obj = @cache[@cache_index]
-        @cache_index += 1
-        obj
-      else
-        nil
-      end
-    end
-
-    # def fetch_batch(param, values, max_size)
-    #   objects = []
-    #   chunks = []
-    #   (0...values.size).step(max_size) do |i|
-    #     chunks << values[i...i+max_size]
-    #   end
-    #   chunks.each_with_index do |obj, i|
-    #     begin
-    #       set_fetch_options({param: chunk.join(',')})
-    #       objects << fetch_page
-    #     rescue HTTPError => e
-    #       # max url length is 8192 (2^13). If longer, will give a 414 error.
-    #       if [413, 414].include? e.code
-    #         objects << fetch_batch(param, chunk, (max_size/2.0).ceil)
-    #       else
-    #         # raise a certain error?
-    #         raise e
-    #       end
-    #     end
-    #   end
-    #   objects
-    # end
-
-    def fetch_page(index = 0, limit = nil)
-      limit = @page_length if limit.nil?
-
-      @fetch_options[:_start] = index
-      @fetch_options[:_limit] = limit
-
-      # all class#node functions can take an arg, so far, only list items need it. 
-      # having list_id usually be nil (that is, undefined) is fine. probably.
-      data = @client.get(@klass.node(@list_id), options: @fetch_options)
-
-      objects = []
-      data.fetch('objects', []).each do |obj|
-        objects << @klass.new(obj)
-      end
-      objects
-    end
-
-    def reset_cache
-      # shouldn't reset options, that's silly
-      # @fetch_options = {}
-      @cache = []
-      @cache_index = 0
-      @page_index = 0
-    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
-        chunk_size = objs.size > @page_length ? @page_length : objs.size
-        chunk = objs[0...chunk_size]
-        objs = chunk_size < objs.size ? objs[chunk_size..-1] : []
-
-        batch_objs = batch_helper(mode, chunk)
-        return_objs['success_objects'] = batch_objs.fetch('success_objects', [])
-        return_objs['error_objects'] = batch_objs.fetch('error_objects', [])
-      end
-      return_objs
-    end
-
-    def batch_helper(mode, objs)
-      payloads = []
-      objs.each {|o| payloads << o.payload}
-
-      if mode == :create
-        batch_results = @client.post('/createBatch', {objects: payloads})
-      elsif mode == :update
-        batch_results = @client.put('/updateBatch', {objects: payloads})
-      else
-        raise RIQError, 'Invalid Batch Mode'
-      end
-      
-      batch_results['success_objects'] = []
-      batch_results['successObjects'].each do |o| 
-        batch_results['success_objects'] << self.class(o)
-      end
-      
-      batch_results['error_objects'] = []
-      batch_results['errorObjects'].each do |o| 
-        batch_results['error_objects'] << self.class(o)
-      end
-
-      batch_results
-    end
-  end
-
-  class << self
-    # @!macro [new] conv
-    #   Returns an iterator for all $0
-    #   @return [BatchManager] 
-
-    # @macro conv
-    def lists(page_size = nil)
-      BatchManager.new(RIQ::List, page_size)
-    end
-
-    # @macro conv
-    def contacts(page_size = nil)
-      BatchManager.new(RIQ::Contact, page_size)
-    end
-
-    # @macro conv
-    def accounts(page_size = nil)
-      BatchManager.new(RIQ::Account, page_size)
-    end
-  end
-end