contactually-rb 0.1.1

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+env: CODECLIMATE_REPO_TOKEN=9457072d7c7f1610175a27a9c1aa484dfc680e6b66cabc4dea96dba7658aa93c
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at pair+ncavig@realscout.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in contactually-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    contactually-rb (0.1.1)
+      faraday (~> 0.9.2)
+      faraday_middleware (~> 0.10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    hashdiff (0.3.0)
+    json (2.0.2)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    webmock (2.1.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  codeclimate-test-reporter (~> 0.6.0)
+  contactually-rb!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 
+
+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,76 @@
+# contactually-rb
+
+[![Build Status](https://travis-ci.org/RealScout/contactually-rb.svg?branch=master)](https://travis-ci.org/RealScout/contactually-rb)
+[![Code Climate](https://codeclimate.com/github/RealScout/contactually-rb/badges/gpa.svg)](https://codeclimate.com/github/RealScout/contactually-rb)
+[![Test Coverage](https://codeclimate.com/github/RealScout/contactually-rb/badges/coverage.svg)](https://codeclimate.com/github/RealScout/contactually-rb)
+
+A simple ruby wrapper around [Contactually v2 Api](https://developers.contactually.com/docs/v2/).
+
+__NOTE__: This is a heavily work in progress codebase, and will most definitely have breaking changes as things progress.
+
+## Installation
+
+Gemfile
+
+```
+gem 'contactually-rb', '~> 0.1.1'
+```
+
+System
+
+```
+gem install contactually-rb
+```
+
+## Usage
+
+Simple list contacts example,
+
+```ruby
+require 'contactually'
+
+client = Contactually::Client.new(auth_token: '<auth_token>')
+#   or
+client = Contactually::Client.new(api_key: '<api_key>')
+
+response = client.contacts.list
+# => #<Contactually::Response>
+
+response.data
+# => #<Contactually::Collection>
+
+response.data.total # => 73
+response.raw_response # => #<Faraday::Response>
+
+data = response.data
+contact = data.first # => #<Contactually::Models::Contact>
+contact.first_name # => "Nic"
+
+```
+
+Loop through all contacts (it will yield contact and transparently loop through all contacts in batches of 50 using Contacutally pagination),
+
+```ruby
+client = Contactually::Client.new(auth_token: '<auth_token>')
+
+client.contacts.list_each do |contact|
+  # do something with contact
+end
+```
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/contactually-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Todos
+
+- Support update endpoints
+- Support Contact convenience endpoints (eg: /contacts/:id/notes)
+- Support Create, Destroy endpoints
+- Support other endpoints

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "contactually"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/contactually-api.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'contactually/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "contactually-rb"
+  spec.version       = Contactually::VERSION
+  spec.authors       = ["Nick Blumenthal", "Nic Cavigliano"]
+  spec.email         = ["nick@realscout.com", "ncavig@gmail.com"]
+
+  spec.summary       = ''
+  spec.description   = ''
+  spec.homepage      = "https://github.com/RealScout/contactually-api"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9.2"
+  spec.add_dependency "faraday_middleware", "~> 0.10.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.6.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+end

data/lib/contactually.rb

@@ -0,0 +1,72 @@
+require 'date'
+require 'forwardable'
+
+require 'faraday'
+require 'faraday_middleware'
+
+require 'contactually/version'
+
+module Contactually
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :adapter
+
+    def initialize
+      @adapter = Faraday.default_adapter
+    end
+  end
+
+  class Error < StandardError
+    attr_reader :messages
+
+    def initialize(messages)
+      @messages = messages
+      super(messages.join(','))
+    end
+  end
+
+  class ForbiddenError < Error
+  end
+
+  class NotFoundError < Error
+  end
+
+  class UnauthorizedError < Error
+  end
+end
+
+require 'contactually/models/model'
+require 'contactually/middleware/error_middleware'
+
+require 'contactually/models/address'
+require 'contactually/models/bucket'
+require 'contactually/models/email_address'
+require 'contactually/models/phone_number'
+require 'contactually/models/social_media_profile'
+require 'contactually/models/tag'
+require 'contactually/models/website'
+require 'contactually/models/contact'
+require 'contactually/models/task'
+require 'contactually/models/user'
+
+require 'contactually/client'
+require 'contactually/base'
+require 'contactually/buckets'
+require 'contactually/collection'
+require 'contactually/contacts'
+require 'contactually/interface'
+require 'contactually/me'
+require 'contactually/response'
+require 'contactually/tags'
+require 'contactually/tasks'

data/lib/contactually/base.rb

@@ -0,0 +1,88 @@
+module Contactually
+  class Base
+    attr_reader :url, :interface
+
+    def self.implements(*method_list)
+      @implements = method_list
+    end
+
+    def self.implement_list
+      @implements
+    end
+
+    def initialize(url:, interface:)
+      @url = url
+      @interface = interface
+    end
+
+    def list(params = {})
+      check_implementation(:list)
+      Response.new(interface.get(url, params), self)
+    end
+
+    def list_each(params = {}, &block)
+      check_implementation(:list)
+
+      if block_given?
+        list_in_batches(params) do |items|
+          items.each do |item|
+            block.call(item)
+          end
+        end
+      else
+        enum_for :list_each, params
+      end
+    end
+
+    def create
+      check_implementation(:create)
+    end
+
+    def fetch(id, params = {})
+      check_implementation(:fetch)
+      Response.new(interface.get(build_fetch_url(id), params), self)
+    end
+
+    def update
+      check_implementation(:update)
+    end
+
+    def delete
+      check_implementation(:delete)
+    end
+
+    def check_implementation(method)
+      raise 'Error' unless self.class.implement_list.include?(method)
+    end
+
+    def model
+      OpenStruct
+    end
+
+    private
+
+    def build_fetch_url(id = nil)
+      if id
+        url + "/" + id.to_s
+      else
+        url
+      end
+    end
+
+    def list_in_batches(params)
+      collection = Response.new(interface.get(url, params), self).data
+      return unless collection.total > 0
+
+      while collection.items.any?
+        yield collection
+
+        break unless collection.has_next_page?
+
+        url = collection.next_page
+        _old_page = params.delete(:page)
+
+        collection = Response.new(interface.get(url, params), self).data
+      end
+    end
+  end
+end