pocus 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8896dcbe66d0ba28169c9cd8f073d9b165f7bbf2
+  data.tar.gz: 9eabcc7873c4040bdc0caee91c37b63787056b0c
+SHA512:
+  metadata.gz: b64105a21925bbfc931c664e82650c41149573074983f08674762fb5332e0bba69a5c754a1befeff2696b851363c280c4a9bf39c1270a8cf372f90786370f4b1
+  data.tar.gz: 781724db172ae05386e1031cbac66e11704c64aa853459475f3a516e17232588e31ca43ab6997eaeb671a9fbafae92f049c1b69b95aaf29a4265c2978e873fd1

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2016 [Varyonic](https://www.varyonic.com).
+
+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

@@ -0,0 +1,100 @@
+# Pocus
+
+[![Gem Version](https://badge.fury.io/rb/pocus.svg)](http://badge.fury.io/rb/pocus)
+[![Code Climate GPA](https://codeclimate.com/github//pocus.svg)](https://codeclimate.com/github//pocus)
+[![Code Climate Coverage](https://codeclimate.com/github//pocus/coverage.svg)](https://codeclimate.com/github//pocus)
+[![Gemnasium Status](https://gemnasium.com//pocus.svg)](https://gemnasium.com//pocus)
+[![Travis CI Status](https://secure.travis-ci.org//pocus.svg)](https://travis-ci.org//pocus)
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+# Table of Contents
+
+- [Features](#features)
+- [Requirements](#requirements)
+- [Setup](#setup)
+- [Usage](#usage)
+- [Tests](#tests)
+- [Versioning](#versioning)
+- [Code of Conduct](#code-of-conduct)
+- [Contributions](#contributions)
+- [License](#license)
+- [History](#history)
+- [Credits](#credits)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
+# Features
+
+Unofficial Ruby API client for [iContact API](See https://www.icontact.com/developerportal), fka. Vocus
+
+# Requirements
+
+0. [MRI 2.3.0](https://www.ruby-lang.org)
+
+# Setup
+
+For a secure install, type the following (recommended):
+
+    gem cert --add <(curl --location --silent https://www.varyonic.com/gem-public.pem)
+    gem install pocus --trust-policy MediumSecurity
+
+NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
+allowing the installation of unsigned dependencies since they are beyond the scope of this gem.
+
+For an insecure install, type the following (not recommended):
+
+    gem install pocus
+
+Add the following to your Gemfile:
+
+    gem "pocus"
+
+# Usage
+
+# Tests
+
+To run the tests you will need your own iContact account with a test folder.  Populate ~/.pocus/fixtures.yml as follows:
+
+```
+	credentials:
+	  app_id: ...
+	  username: ...
+	  password: ...
+	account_id: ...
+	test_client_folder_id: ...
+```
+To test, run:
+
+    bundle exec rake
+
+# Versioning
+
+Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
+
+- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+
+# Code of Conduct
+
+Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By participating in this project
+you agree to abide by its terms.
+
+# Contributions
+
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+# License
+
+Copyright (c) 2016 [Varyonic](https://www.varyonic.com).
+Read the [LICENSE](LICENSE.md) for details.
+
+# History
+
+Read the [CHANGELOG](CHANGELOG.md) for details.
+Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
+
+# Credits
+
+Developed by [Piers Chambers](https://www.varyonic.com) at [Varyonic](https://www.varyonic.com).

data/lib/pocus/account.rb

@@ -0,0 +1,8 @@
+module Pocus
+  class Account < Resource
+    self.path = :a
+    self.primary_key = :account_id
+
+    has_many :clientfolders, path: '/c', class: 'ClientFolder'
+  end
+end

data/lib/pocus/association.rb

@@ -0,0 +1,35 @@
+module Pocus
+  class Association < Array
+    attr_reader :owner, :path, :klass
+
+    def initialize(owner, name, options)
+      @owner = owner
+      @path = options[:path] || "/#{name}"
+      @klass = Object.const_get('Pocus::'.concat(options[:class] || camelize(name)))
+    end
+
+    def all
+      owner.get_multiple(path, klass)
+    end
+
+    def create(fields_multiple)
+      if fields_multiple.is_a?(Array)
+        owner.post_multiple(path, klass, fields_multiple)
+      else
+        response = owner.post_multiple(path, klass, [fields_multiple])
+        return response if response.empty?
+        resource = response.first
+        resource.assign_attributes(errors: response.errors || [], warnings: response.warnings || [])
+        resource
+      end
+    end
+
+    def find(id)
+      owner.get("#{path}/#{id}", klass)
+    end
+
+    def where(filters)
+      owner.get_multiple(path, klass, filters)
+    end
+  end
+end

data/lib/pocus/client_folder.rb

@@ -0,0 +1,14 @@
+module Pocus
+  # See https://www.icontact.com/developerportal/documentation/client-folders
+  class ClientFolder < Resource
+    self.path = :c
+    self.primary_key = :client_folder_id
+
+    has_many :lists, class: 'List'
+    has_many :contacts, class: 'Contact'
+    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/contact.rb

@@ -0,0 +1,7 @@
+module Pocus
+  # See https://www.icontact.com/developerportal/documentation/contacts
+  class Contact < Resource
+    self.path = :contacts
+    self.primary_key = :contact_id
+  end
+end

data/lib/pocus/custom_field.rb

@@ -0,0 +1,7 @@
+module Pocus
+  # See https://www.icontact.com/developerportal/documentation/custom-fields
+  class CustomField < Resource
+    self.path = :customfields
+    self.primary_key = :custom_field_id
+  end
+end

data/lib/pocus/identity.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pocus
+  # Gem identity information.
+  module Identity
+    def self.name
+      'pocus'
+    end
+
+    def self.label
+      'Pocus'
+    end
+
+    def self.version
+      '0.5.0'
+    end
+
+    def self.version_label
+      "#{label} #{version}"
+    end
+  end
+end

data/lib/pocus/list.rb

@@ -0,0 +1,7 @@
+module Pocus
+  # See https://www.icontact.com/developerportal/documentation/lists
+  class List < Resource
+    self.path = :lists
+    self.primary_key = :list_id
+  end
+end

data/lib/pocus/permission.rb

@@ -0,0 +1,7 @@
+module Pocus
+  # https://www.icontact.com/developerportal/documentation/permissions
+  class Permission < Resource
+    self.path = :permissions
+    self.primary_key = nil
+  end
+end

data/lib/pocus/resource.rb

@@ -0,0 +1,169 @@
+module Pocus
+  # Combine array of resources returned by API with error and warning attributes.
+  class ResponseArray < Array
+    attr_reader :errors, :warnings
+
+    def initialize(resources, errors, warnings)
+      @errors = (errors || [])
+      @warnings = (warnings || [])
+      super resources
+    end
+  end
+
+  # Base class for API resources.
+  class Resource
+    attr_reader :path
+    attr_accessor :parent
+
+    class << self
+      attr_accessor :path, :primary_key
+
+      def associations
+        @associations ||= {}
+      end
+
+      def has_many(name, options = {})
+        attr_accessor(name)
+        associations[name] = options
+      end
+
+      def tag
+        name.split('::').last.downcase
+      end
+
+      def tag_multiple
+        tag.concat('s')
+      end
+    end
+
+    def initialize(attributes)
+      assign_attributes(attributes)
+      self.class.associations.each_pair do |name, options|
+        send("#{name}=", Association.new(self, name, options))
+      end
+    end
+
+    def assign_attributes(attributes)
+      attributes.each do |ck, v|
+        k = underscore(ck)
+        self.class.__send__(:attr_accessor, k) unless respond_to?(k)
+        send("#{k}=", v)
+      end
+    end
+
+    def delete
+      session.send_request('DELETE', path) == []
+    end
+    alias destroy delete
+
+    def fields
+      field_names.reduce(Hash[]) do |hash, field_name|
+        hash.tap { |h| h[camelize field_name] = send field_name }
+      end
+    end
+
+    # Fetch and instantiate a single resource from a path.
+    def get(request_path, klass)
+      response = session.send_request('GET', path + request_path)
+      data = response.fetch(klass.tag)
+      resource = klass.new(data.merge(parent: self))
+      resource.assign_errors(response)
+      resource
+    end
+
+    def get_multiple(request_path, klass, filters = {})
+      response = session.send_request('GET', path + request_path, camelize_filters(filters))
+      data = response.fetch(klass.tag_multiple)
+      resources = data.map { |fields| klass.new(fields.merge(parent: self)) }
+      ResponseArray.new(resources, response['errors'], response['warnings'])
+    end
+
+    def id
+      send self.class.primary_key
+    end
+
+    def logger
+      session.logger
+    end
+
+    def path
+      "#{parent ? parent.path : ""}/#{self.class.path}/#{id}"
+    end
+
+    def post
+      response = session.send_request('POST', path, fields)
+      assign_attributes(response.fetch(self.class.tag))
+      assign_errors(response)
+      self
+    rescue UnexpectedHttpResponse => e
+      response = JSON.parse(e.response.body)
+      response['errors'] || response['warnings'] or raise
+      assign_errors(response)
+      self
+    end
+
+    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)) }
+      ResponseArray.new(resources, response['errors'], response['warnings'])
+    end
+
+    # Fetch and update this resource from a path.
+    def reload
+      response = session.send_request('GET', path)
+      assign_attributes(response.fetch(self.class.tag))
+      assign_errors(response)
+      self
+    end
+
+    def session
+      Session.instance
+    end
+
+    protected
+
+    def required(attributes, attr_names)
+      missing = attr_names - attributes.keys
+      fail "missing required atrributes: #{missing.inspect}" if missing.any?
+    end
+
+    def camelize(str)
+      return str.to_s unless str.to_s.include?('_')
+      parts = str.to_s.split('_')
+      first = parts.shift
+      first + parts.each(&:capitalize!).join
+    end
+
+    def camelize_fields(hash)
+      hash.reduce({}) do |h, e|
+        h[camelize e[0]] = e[1]
+        h
+      end
+    end
+
+    def camelize_filters(hash)
+      hash.reduce({}) do |h, e|
+        key = camelize(e[0])
+        h[key] = e[1]
+        h[key + 'SearchType'] = 'eq'
+        h
+      end
+    end
+
+    def field_names
+      instance_variables.map { |n| n.to_s.sub('@', '').to_sym } - [:session, :parent, :path]
+    end
+
+    def assign_errors(response)
+      assign_attributes(errors: response['errors'] || [], warnings: response['warnings'] || [])
+    end
+
+    def underscore(camel_cased_word)
+      camel_cased_word.to_s.dup.tap do |word|
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.downcase!
+      end
+    end
+  end
+end

data/lib/pocus/segment.rb

@@ -0,0 +1,9 @@
+module Pocus
+  # https://www.icontact.com/developerportal/documentation/segments
+  class Segment < Resource
+    self.path = :segments
+    self.primary_key = :segment_id
+
+    has_many :criteria, class: 'SegmentCriteria'
+  end
+end

data/lib/pocus/segment_criteria.rb

@@ -0,0 +1,11 @@
+module Pocus
+  # https://www.icontact.com/developerportal/documentation/segment-criteria
+  class SegmentCriteria < Resource
+    self.path = :criteria
+    self.primary_key = :criterion_id
+
+    def self.tag_multiple
+      'criteria'
+    end
+  end
+end

data/lib/pocus/session.rb

@@ -0,0 +1,79 @@
+require 'benchmark'
+require 'json'
+require 'logger'
+
+# See https://www.icontact.com/developerportal/documentation
+module Pocus
+  class UnexpectedHttpResponse < RuntimeError
+    attr_reader :response
+    def initialize(response)
+      @response = response
+      super "Unexpected response [#{response.code}] #{response.body}"
+    end
+  end
+
+  # Sends authenticated JSON requests to remote service using HTTPS.
+  class Session
+    BASE_URL = 'https://api.invoc.us/icp'.freeze
+    attr_reader :credentials
+    attr_accessor :logger
+
+    def initialize(app_id: '', username: '', password: '', logger: Logger.new('/dev/null'))
+      @credentials = {
+        'API-AppId'    => app_id,
+        'API-Username' => username,
+        'API-Password' => password
+      }
+      @logger = logger
+    end
+
+    def self.config(options = {})
+      @config = options
+    end
+
+    def self.instance
+      @instance ||= new(@config)
+    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))
+      fail UnexpectedHttpResponse, response unless response.is_a? Net::HTTPSuccess
+      JSON.parse(response.body)
+    end
+
+    protected
+
+    def headers(type = 'application/json')
+      Hash['API-Version' => '2.2', 'Accept' => type, 'Content-Type' => type]
+    end
+
+    def https(uri)
+      Net::HTTP.new(uri.host, uri.port).tap do |http|
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+
+    def request_data(fields)
+      fields.to_json unless fields.empty?
+    end
+
+    def send_logged_request(uri, method, data)
+      log_request_response(uri, method, data) do |u, m, d|
+        https(uri).send_request(m, u.to_s, d, headers.merge(credentials))
+      end
+    end
+
+    def log_request_response(uri, method, data)
+      logger.info "request = #{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}")
+      response
+    end
+  end
+end

data/lib/pocus/subscription.rb

@@ -0,0 +1,6 @@
+module Pocus
+  class Subscription < Resource
+    self.path = :subscriptions
+    self.primary_key = :subscription_id
+  end
+end

data/lib/pocus/user.rb

@@ -0,0 +1,9 @@
+module Pocus
+  # https://www.icontact.com/developerportal/documentation/users
+  class User < Resource
+    self.path = :users
+    self.primary_key = :user_id
+
+    has_many :permissions, class: 'Permission'
+  end
+end

data/lib/pocus.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'pocus/identity'
+require 'pocus/session.rb'
+require 'pocus/association.rb'
+require 'pocus/resource.rb'
+require 'pocus/account.rb'
+require 'pocus/client_folder.rb'
+
+require 'pocus/user.rb'
+require 'pocus/permission.rb'
+
+require 'pocus/list.rb'
+require 'pocus/contact.rb'
+require 'pocus/custom_field.rb'
+require 'pocus/segment.rb'
+require 'pocus/segment_criteria.rb'
+require 'pocus/subscription.rb'

data/lib/tasks/console.rake

@@ -0,0 +1,7 @@
+desc 'Open IRB console for gem development environment'
+task :console do
+  require 'irb'
+  require 'pocus'
+  ARGV.clear
+  IRB.start
+end

data/lib/tasks/rspec.rake

@@ -0,0 +1,6 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => error
+  puts error.message
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,6 @@
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError => error
+  puts error.message
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: pocus
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Piers Chambers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.7'
+- !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:
+    - - ">="
+      - !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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'
+description: Unofficial Ruby client for iContact API
+email:
+- piers@varyonic.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- LICENSE.md
+- README.md
+- lib/pocus.rb
+- lib/pocus/account.rb
+- lib/pocus/association.rb
+- lib/pocus/client_folder.rb
+- lib/pocus/contact.rb
+- lib/pocus/custom_field.rb
+- lib/pocus/identity.rb
+- lib/pocus/list.rb
+- lib/pocus/permission.rb
+- lib/pocus/resource.rb
+- lib/pocus/segment.rb
+- lib/pocus/segment_criteria.rb
+- lib/pocus/session.rb
+- lib/pocus/subscription.rb
+- lib/pocus/user.rb
+- lib/tasks/console.rake
+- lib/tasks/rspec.rake
+- lib/tasks/rubocop.rake
+homepage: https://github.com//pocus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Unofficial Ruby client for iContact API
+test_files: []