pocus 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd0d631d3b8cf6ef526d738b4d4072a6bb9828fe9752d08df511cd0643278d7d
-  data.tar.gz: 31e2a7de81869a442640f053057dad727052004fb2e2d61f24b085ae73161a4c
+  metadata.gz: 02c9225454a2501e4a0e0defeb658efab6e98605af4992a5304eed799e29b10e
+  data.tar.gz: 427a91c96bfc410c107ba17cabc7b0e96307b56fa655f4b463e03ac39e8a4a3d
 SHA512:
-  metadata.gz: c22999094d8d036434a0b03ed2505e9a1a9fc2eb8b17aec0d8dd81320658518e3ce978079bd40df187b9da5ddd0aef8d7e68b8a49c3f9cf92cd8a2c7f9525200
-  data.tar.gz: 7d113e2c3d7e511de3086a7c167a6e8d702d01af4d193a505547c5beae9b34df128c6a1a1b9a0eeada70729846709722ec572473afad9d3a339752ebd4de27dc
+  metadata.gz: 527b43fc28027052bc70ca44118d7276f0b736c819abeaf99eb3e73aa9e6fec1d974c0f86fa0e711cc25616642d677af479df363f99827011aa765f2a36efbfe
+  data.tar.gz: 59b882592a4d9053cc1f80782a6fde301653e979a76083912a9b07edba13935009053d0c1740da3855899609c18c8ab4de7095477ed55e0d7619f6d50ab5f2c9

data/README.md

@@ -18,21 +18,33 @@ And then execute:
 
     $ bundle
 
+## Requirements
+
+iContact account, AppID and credentials, see the [iContact API Getting Started Guide](https://www.icontact.com/developerportal/documentation/start-building).
+
 ## Usage
 
-Example:
+Configure a connection and connect to the account:
 
+```ruby
+    credentials = { host: 'app.icontact.com', app_id: a, username: u, password: p }
+    session = Pocus::Session.new(credentials)
+    session.logger = Rails.logger
+	account = Pocus::Account.new(session: session, account_id: account_id)
 ```
-	Pocus::Session.config(credentials)
-	Pocus::Session.instance.logger = Rails.logger
-	account = Pocus::Account.new(account_id: account_id)
+
+Navigate and update entities:
+
+```ruby
 	folder = acount.clientfolders.find(folder_id)
 	folder.contacts.create(contacts_data)
 ```
 
+See the specs for sample code.
+
 ## Tests
 
-To run the tests you will need your own iContact account with a test folder.  Set the following environment variables:
+To run the tests you will need your own iContact account with a test folder (name: 'My First List').  Set the following environment variables:
 
 ```
 POCUS_APP_ID=0b34...b478c

data/lib/pocus/account.rb

@@ -3,6 +3,8 @@ module Pocus
     self.path = :a
     self.primary_key = :account_id
 
+    attr_accessor :session
     has_many :clientfolders, path: '/c', class: 'ClientFolder'
+    has_many :users, class: 'User'
   end
 end

data/lib/pocus/association.rb

@@ -28,6 +28,10 @@ module Pocus
       owner.get("#{path}/#{id}", klass)
     end
 
+    def find_or_create_by(attributes)
+      where(attributes).first || create(attributes)
+    end
+
     def where(filters)
       owner.get_multiple(path, klass, filters)
     end

data/lib/pocus/client_folder.rb

@@ -9,6 +9,5 @@ module Pocus
     has_many :customfields, class: 'CustomField'
     has_many :segments, class: 'Segment'
     has_many :subscriptions, class: 'Subscription'
-    has_many :users, class: 'User'
   end
 end

data/lib/pocus/identity.rb

@@ -12,7 +12,7 @@ module Pocus
     end
 
     def self.version
-      '0.6.1'
+      '1.0.0'
     end
 
     def self.version_label

data/lib/pocus/resource.rb

@@ -119,7 +119,7 @@ module Pocus
     end
 
     def session
-      Session.instance
+      parent.session
     end
 
     def marshal_dump

data/lib/pocus/session.rb

@@ -16,11 +16,12 @@ module Pocus
 
   # Sends authenticated JSON requests to remote service using HTTPS.
   class Session
-    BASE_URL = 'https://api.invoc.us/icp'.freeze
+    attr_reader :base_url
     attr_reader :credentials
     attr_accessor :logger
 
-    def initialize(app_id: '', username: '', password: '', logger: Logger.new('/dev/null'))
+    def initialize(host: 'api.invoc.us', app_id:, username:, password:, logger: Logger.new('/dev/null'))
+      @base_url = "https://#{host}/icp".freeze
       @credentials = {
         'API-AppId'    => app_id,
         'API-Username' => username,
@@ -29,18 +30,15 @@ module Pocus
       @logger = logger
     end
 
-    def self.config(options = {})
-      @config = options
-    end
-
-    def self.instance
-      @instance ||= new(@config)
+    # 'Pro' is legacy as moniker dropped.
+    def pro?
+      base_url =~ /invoc.us/
     end
 
     # Accepts hash of fields to send.
     # Returns parsed response body, always a hash.
     def send_request(method, path, fields = {})
-      response = send_logged_request(URI(BASE_URL + path), method, request_data(fields))
+      response = send_logged_request(URI(base_url + path), method, request_data(fields))
       fail UnexpectedHttpResponse, response unless response.is_a? Net::HTTPSuccess
       JSON.parse(response.body)
     end
@@ -69,13 +67,17 @@ module Pocus
     end
 
     def log_request_response(uri, method, data)
-      logger.info "request = #{method} #{uri}#{data ? '?' + data : ''}"
+      logger.info  "[#{self.class.name}] request = #{method} #{uri}#{data ? '?' + data : ''}"
       response = nil
       tms = Benchmark.measure do
         response = yield uri, method, data
       end
-      logger.info("API response (#{tms.real}s): #{response.inspect} #{response.body}")
+      logger.info  "[#{self.class.name}] response (#{ms(tms)}ms): #{response.inspect} #{response.body}"
       response
     end
+
+    def ms(tms)
+      (tms.real*1000).round(3)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pocus
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Piers Chambers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-21 00:00:00.000000000 Z
+date: 2019-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-state
   requirement: !ruby/object:Gem::Requirement
@@ -127,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Unofficial Ruby client for iContact API