pocus 0.6.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd0d631d3b8cf6ef526d738b4d4072a6bb9828fe9752d08df511cd0643278d7d
-  data.tar.gz: 31e2a7de81869a442640f053057dad727052004fb2e2d61f24b085ae73161a4c
+  metadata.gz: 50a4404a6f892888678d3d4fdd038133696beaece4d7cbb6e7e92dffd8b00b8e
+  data.tar.gz: 2418eef7353f39b5b7ff913993277ba1369707c7e64ae03b5baef40a2c8551c7
 SHA512:
-  metadata.gz: c22999094d8d036434a0b03ed2505e9a1a9fc2eb8b17aec0d8dd81320658518e3ce978079bd40df187b9da5ddd0aef8d7e68b8a49c3f9cf92cd8a2c7f9525200
-  data.tar.gz: 7d113e2c3d7e511de3086a7c167a6e8d702d01af4d193a505547c5beae9b34df128c6a1a1b9a0eeada70729846709722ec572473afad9d3a339752ebd4de27dc
+  metadata.gz: c993ee6385f43f1fc06d7253bfc4c790c713c9fabba38199ee225ec25db188141cd7ccc61fff4b6ab090a6d17f7d753be154cc65e95ba5505e9cc5dbcc6e34ab
+  data.tar.gz: ec1ebf2100cf5390c412eac26ea5586068e24b4cc2c80a968a86b7700e7610ab49cf2531c9f10ba28370552a04735dc93e81d4c2276b56465d82d11f76f2e24e

data/README.md

@@ -1,8 +1,7 @@
 # Pocus
 
 [![Gem Version](https://badge.fury.io/rb/pocus.svg)](http://badge.fury.io/rb/pocus)
-[![Code Climate GPA](https://codeclimate.com/github/varyonic/pocus.svg)](https://codeclimate.com/github/varyonic/pocus)
-[![Travis CI Status](https://secure.travis-ci.org/varyonic/pocus.svg)](https://travis-ci.org/varyonic/pocus)
+[![Github Actions  ][actions_badge]][actions]
 
 Unofficial Ruby API client for [iContact API](https://www.icontact.com/developerportal) (f.k.a. Vocus), inspired by Active Resource.
 
@@ -18,21 +17,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
@@ -59,4 +70,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 Read the [LICENSE](LICENSE.md) for details.
 
-Copyright (c) 2016-2019 [Varyonic](https://www.varyonic.com).
+Copyright (c) 2016-2025 [Varyonic](https://www.varyonic.com).
+
+[actions_badge]: https://github.com/varyonic/pocus/workflows/ci/badge.svg
+[actions]: https://github.com/varyonic/pocus/actions

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.1.0'
     end
 
     def self.version_label

data/lib/pocus/resource.rb

@@ -5,7 +5,7 @@ module Pocus
 
     def initialize(resources, errors, warnings)
       @errors = (errors || [])
-      @warnings = (warnings || [])
+      @warnings = (warnings || []).reject { |w| w =~ /Your account is past due/ }
       super resources
     end
   end
@@ -106,7 +106,8 @@ module Pocus
     def post_multiple(request_path, klass, fields_multiple)
       data = fields_multiple.map { |fields| camelize_fields(fields) }
       response = session.send_request('POST', path + request_path, data)
-      resources = response.fetch(klass.tag_multiple).map { |fields| klass.new(fields.merge(parent: self)) }
+      data = response.fetch(klass.tag_multiple) || []
+      resources = data.map { |fields| klass.new(fields.merge(parent: self)) }
       ResponseArray.new(resources, response['errors'], response['warnings'])
     end
 
@@ -119,7 +120,7 @@ module Pocus
     end
 
     def session
-      Session.instance
+      parent.session
     end
 
     def marshal_dump
@@ -165,7 +166,7 @@ module Pocus
     end
 
     def assign_errors(response)
-      assign_attributes(errors: response['errors'] || [], warnings: response['warnings'] || [])
+      assign_attributes(errors: response['errors'] || [], warnings: (response['warnings'] || []).reject { |w| w =~ /Your account is past due/ })
     end
 
     def underscore(camel_cased_word)

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,59 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: pocus
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Piers Chambers
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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-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
     requirements:
     - - ">="
@@ -86,8 +43,8 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.md
+- README.md
 files:
 - LICENSE.md
 - README.md
@@ -112,7 +69,6 @@ homepage: https://github.com/varyonic/pocus
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -127,9 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Unofficial Ruby client for iContact API
 test_files: []