relateiq_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d76f0dcb80b88ed13562008b96e62dc0f05262c
-  data.tar.gz: a83f7a7529adaf15afb70a4e2798e46d76502e09
+  metadata.gz: 90da560ced1f38046deb4d991fceeb7a16e24382
+  data.tar.gz: b86006dd57fb30beace2392a0b4c231b2faba68e
 SHA512:
-  metadata.gz: 4554051152c064be0e3bdca324b7e63aa04b553e5cfe4fef648717679b31481df4b2c3a617626b9eef6a8bb6820fa3056ce78b2addc22abd68427e005521991c
-  data.tar.gz: efdb4428faabdd3f1e6e48f3867a427202ff9024dd2c76dd5b8507c52ecad0461ddf5a6d3feb12a55feab031f1986b993066a7e9143cebf91d8da91066223860
+  metadata.gz: 4500954c70b5d1f25205e8c640bb4552b007d1842db4afd008ee6ae8099b8742afafd7353e4edb8de8d6598774ad9729b7cc5bcc7ee8e3a96c40d74893f596d3
+  data.tar.gz: 64e071527776e866801654e41114926f58f84e9178ef268d088b0e9813e71d0517a94620d140c3882d36472d8a6ee51a1202d15007cfe2b89887b01861c65b63

data/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     relateiq_client (0.1.0)
-      rest-client (~> 1.7)
+      rest-client (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
@@ -25,15 +25,19 @@ GEM
       safe_yaml (~> 1.0.0)
     debug_inspector (0.0.2)
     diff-lcs (1.2.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
     httparty (0.13.5)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
     json (1.8.2)
     method_source (0.8.2)
-    mime-types (2.6.1)
+    mime-types (2.6.2)
     multi_json (1.10.1)
     multi_xml (0.5.5)
-    netrc (0.7.9)
+    netrc (0.10.3)
     parser (2.2.2.0)
       ast (>= 1.1, < 3.0)
     powerpack (0.1.0)
@@ -46,7 +50,8 @@ GEM
       pry (>= 0.9.11)
     rainbow (2.0.0)
     rake (10.4.2)
-    rest-client (1.7.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
     rspec (3.1.0)
@@ -80,6 +85,9 @@ GEM
     terminal-table (1.4.5)
     thor (0.19.1)
     tilt (2.0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
     valise (1.1.4)
     webmock (1.21.0)
       addressable (>= 2.3.6)

data/README.md

@@ -20,17 +20,94 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+To use this gem you must generate an API access token from the RelateIQ settings
+screen and allow it access to the lists you want to work with. Once you have
+your API credentials, you can configure them like so:
+
+```ruby
+RelateIq.configure do |config|
+  config.baseurl  = 'https://api.relateiq.com/v2' # (default)
+  config.username = 'xxx'
+  config.password = 'xxx'
+end
+```
+
+### Lists
+
+#### Find a list by title
+
+```ruby
+RelateIq::List.find_by_title('leads')
+```
+
+*Note:* case insensitive
+
+
+#### Find a list by id
+
+```ruby
+RelateIq::List.find('xxxYYYaaaa')
+```
+
+#### Get all lists
+
+```ruby
+RelateIq::List.all
+```
+
+*Note:* this gets stored in cache every time it is called (or when any find
+command is called) to clear the cache use the following
+
+```ruby
+RelateIq::List.clean_cache
+```
+
+#### Find all list items for a contact
+
+```ruby
+list = RelateIq::List.find_by_title('leads')
+list.items_by_contact_id('somecontactid')
+```
+
+#### Upsert Item
+
+```ruby
+list = RelateIq::List.find_by_title('leads')
+list_item_hash = {
+  name: 'Carl Sagan',
+  field_values: {
+    'website': 'https://cosmos.com',
+    'title':   'Astronomer, science educator'
+  }
+}
+list.upsert_item(list_item_hash)
+```
+
+*Note:* this is where the magic happens with this gem: using the list information
+pulled from the List.all endpoint that we cached before we can now automatically
+map field names to values - this is all done for you behind the scenes so you
+can avoid storing ids for fields.
+
+Another great benefit for this approach is that it allows you to have a staging
+list that you can use to test integration and build out new features.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle install` to install dependencies. Then,
+run `rspec spec` to run the tests. You can also run `bundle console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, first build it using `gem build
+relateiq.gemspec`. When the gem is built you can install it directly using `gem
+install ./relateiq-0.1.0.gem`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/relateiq.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/dkarter/RelateIQClient.
+
+All pull requests are expected to have specs and be well tested.
 
 
 ## License

data/lib/relateiq/version.rb

@@ -1,3 +1,3 @@
 module RelateIq
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/relateiq.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = [ 'lib' ]
 
-  s.add_dependency 'rest-client', '~> 1.7'
+  s.add_dependency 'rest-client', '~> 1.8'
 
   s.add_development_dependency 'bundler', '~> 1.7'
   s.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relateiq_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dorian Karter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -276,3 +276,4 @@ test_files:
 - spec/lib/relateiq/utils/field_value_encoder_spec.rb
 - spec/relate_iq_spec.rb
 - spec/spec_helper.rb
+has_rdoc: