pipelinedeals-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d5ee47ee85e4a3694e707bf901dca60abfdbcad
+  data.tar.gz: 69dcf44605522c84d0d17bd0298bc64066a7c05a
+SHA512:
+  metadata.gz: 9e08b1b7473ef656dd23f98ce14c683b9b87b9b7d774bb5a099553a1ed3dabb5d498a7819f3ba8c0eaa2f86103f9d0ce5ed04af49009abe0182e7d4c801078ca
+  data.tar.gz: c76a7203b279f68328ee51fe309e5ffceebc73c73d81f7d2db544f2c00054592c1c9adfcf425c7c606f037a982d9c51d67b70c5183158cefe7ebf83235d0bba3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pipelinedeals-client.gemspec
+gemspec
+
+group :test do
+  gem "pry"
+  gem "pry-nav"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 vaberay
+
+MIT License
+
+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,74 @@
+# Pipelinedeals::Client
+
+This gem is designed to communicate with the *Pipeline Deals API*
+through instantiation of the main class **PipelineDeals::Client**.
+To instantiate you need the API key from a Pipeline Deals account.
+
+This Gem supports the following **Pipeline Deals API** methods:
+
+* People
+* Users
+# Person_custom_fields(get)
+
+All methods in this gem use **JSON** formatting. To read on the Pipeline API please visit (https://www.pipelinedeals.com/api/docs/introduction)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pipelinedeals-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pipelinedeals-client
+
+## Usage
+
+To begin:
+
+```ruby
+pipeline = PipelineDeals::Client.new(api_key)
+```
+To check if a successful connection can be made to the API:
+
+```ruby
+pipeline.ping
+```
+This will return *true* or *false*.
+
+The get methods support pagination and the default page size is 200.
+To get the people on the first page (first 200):
+```ruby
+response = pipeline.people
+```
+The response includes metadata for pagination.
+```ruby
+response["per_page"]
+```
+
+You can also get people on a particular page:
+```ruby
+pipeline.people(2)
+```
+This will get all the users on the second page.
+
+To create a person on *Pipeline Deals*:
+```ruby
+pipeline.create_person(person)
+```
+The person parameter has to be formatted according to (https://www.pipelinedeals.com/api/docs/examples).
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pipelinedeals-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/lib/pipelinedeals/client.rb

@@ -0,0 +1,66 @@
+require "pipelinedeals/client/version"
+require "httparty"
+
+module Pipelinedeals
+  class Client
+    attr_reader :api_key
+
+    API_URL = "https://api.pipelinedeals.com/api/v3/"
+
+    def initialize(api_key)
+      @api_key = "#{api_key}"
+    end
+
+    def ping
+      response = users
+      !response.has_key?("errors") && !response.has_key?("error")
+    end
+
+    def users(page = 1)
+      get_request("users", "&page=#{page}")
+    end
+
+    def person_custom_fields(page = 1)
+      get_request("/admin/person_custom_field_labels", "&page=#{page}")
+    end
+
+    def people(page = 1, per_page = 10000)
+      get_request("people", "&page=#{page}&per_page=#{per_page}")
+    end
+
+    def create_person(data, endpoint = "people")
+      post_request(data, endpoint)
+    end
+
+    def update_person(data, id, options = "")
+      put_request(data, "people/#{id}", options)
+    end
+
+    private
+
+    def uri_generator(endpoint, options = "")
+      "#{API_URL}#{endpoint}.json?api_key=#{@api_key}#{options}"
+    end
+
+    def get_request(endpoint, options = "")
+      response = HTTParty.get(uri_generator(endpoint, options))
+      response.parsed_response
+    end
+
+    def post_request(data, endpoint, options = "")
+     uri = uri_generator(endpoint, options)
+     res = HTTParty.post(uri,
+        :body => data,
+        :header => { "Content-type" => "text/json"})
+     res.response
+    end
+
+    def put_request(data, endpoint, options = "")
+      uri = uri_generator(endpoint, options)
+      res = HTTParty.put(uri,
+        :body => data,
+        :header => { "Content-type" => "text/json" })
+      res.response
+    end
+  end
+end

data/lib/pipelinedeals/client/version.rb

@@ -0,0 +1,5 @@
+module Pipelinedeals
+  class Client
+    VERSION = "0.0.1"
+  end
+end

data/pipelinedeals-client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pipelinedeals/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pipelinedeals-client"
+  spec.version       = Pipelinedeals::Client::VERSION
+  spec.authors       = ["vaberay"]
+  spec.email         = ["ramon@wishpond.com"]
+  spec.summary       = %q{To be used with Chatty Panda}
+  spec.description   = %q{This gem is to be interact with te pipelinedeals api.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "sinatra"
+end

data/spec/client_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Pipelinedeals::Client do
+  subject { Pipelinedeals::Client.new }
+  let(:api_key) { '12345abcde'}
+  let(:client) { Pipelinedeals::Client.new(api_key)}
+  let(:bad_api_key) { '12345abcd'}
+  let(:bad_client) { Pipelinedeals::Client.new(bad_api_key)}
+
+  describe '#initialize' do
+    it 'stores the api_key' do
+      expect(client.api_key).to eq(api_key)
+    end
+  end
+
+  describe '#ping' do
+    context 'good api_key' do
+      it 'returns true' do
+        response = client.ping
+        expect(response).to be_truthy
+      end
+    end
+
+    context 'bad_api_key' do
+      it 'returns false' do
+        response = bad_client.ping
+        expect(response).to be_falsey
+      end
+    end
+  end
+
+
+
+  describe '#people' do
+    it 'returns the collection of people' do
+      response = client.people
+      expect(response['pagination']['page']).to eq(1)
+      expect(response['entries'].size).to eq(3)
+    end
+
+    context 'wrong api_key' do
+      it "returns an error message" do
+        response = bad_client.people
+        expect(response['error']).to eq('Unknown api key')
+      end
+    end
+  end
+
+  describe '#users' do
+    it 'return the collection of users' do
+      response = client.users
+      expect(response.has_key?('pagination')).to be_truthy
+    end
+
+    context 'wrong api_key' do
+      it "returns an error message" do
+        response = bad_client.users
+        expect(response['error']).to eq('Unknown api key')
+      end
+    end
+  end
+
+  describe '#person_custom_fields' do
+    it 'returns the collection of custom fields' do
+      response = client.person_custom_fields
+      expect(response.has_key?('pagination')).to be_truthy
+    end
+
+    context 'wrong api_key' do
+      it "returns an error message" do
+        response = bad_client.person_custom_fields
+        expect(response['error']).to eq('Unknown api key')
+      end
+    end
+  end
+end

data/spec/features/external_request_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'External request' do
+  it 'tries to hit the pipelinedeals api' do
+    uri = 'https://pipelinedeals.com'
+
+    response = HTTParty.get(uri)
+
+    expect(response.body).to eq("stubbed response")
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'pipelinedeals/client'
+require 'webmock/rspec'
+require 'support/fake_pipelinedeals'
+require 'pry'
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+RSpec.configure do |config|
+  config.before(:each) do
+    stub_request(:get, "https://pipelinedeals.com").
+      with(headers: {'Accept' => '*/*', 'User-Agent' => 'Ruby'}).
+      to_return(status: 200, body: "stubbed response", headers: {})
+
+    stub_request(:any, /https:\/\/api.pipelinedeals.com\/api\/v3\//).to_rack(FakePipelineDeals)
+  end
+end

data/spec/support/fake_pipelinedeals.rb

@@ -0,0 +1,48 @@
+require 'sinatra/base'
+
+class FakePipelineDeals < Sinatra::Base
+
+  get '/api/v3/people.json' do
+    if check_token(params['api_key'])
+      json_response(200, 'people.json')
+    else
+      json_response(200, 'error.json')
+    end
+  end
+
+  get '/api/v3/users.json' do
+    if check_token(params['api_key'])
+      json_response(200, 'users.json')
+    else
+      json_response(200, 'error.json')
+    end
+  end
+
+  get '/api/v3/admin/person_custom_field_labels.json' do
+     if check_token(params['api_key'])
+      json_response(200, 'person_custom_fields.json')
+    else
+      json_response(200, 'error.json')
+    end
+  end
+
+  post '/api/v3/people.json' do
+    if check_token(params['api_key'])
+      json_response(201, 'create_person.json')
+    else
+      json_response(200, 'error.json')
+    end
+  end
+
+  private
+
+  def json_response(response_code, file_name)
+    content_type :json
+    status response_code
+    File.open(File.dirname(__FILE__) + '/fixtures/' + file_name, 'rb').read
+  end
+
+  def check_token(token)
+    token == '12345abcde'
+  end
+end

data/spec/support/fixtures/error.json

@@ -0,0 +1,3 @@
+{
+  "error":"Unknown api key"
+}

data/spec/support/fixtures/people.json

@@ -0,0 +1,152 @@
+{"entries":
+  [{"bounced":false,
+    "company_id":null,
+    "created_at":"2015/08/08 16:51:28 -0700",
+    "email":"sonya_renner@mosciskilesch.com",
+    "email2":null,
+    "facebook_url":null,
+    "fax":null,
+    "first_name":null,
+    "home_address_1":null,
+    "home_address_2":null,
+    "home_city":null,
+    "home_country":null,
+    "home_email":null,
+    "home_phone":null,
+    "home_postal_code":null,
+    "home_state":null,
+    "id":1043404447,
+    "instant_message":null,
+    "last_name":"Unknown",
+    "linked_in_url":null,
+    "mobile":null,
+    "phone":null,
+    "position":null,
+    "summary":null,
+    "twitter":null,
+    "type":"Contact",
+    "unsubscribed":false,
+    "updated_at":"2015/08/08 16:51:28 -0700",
+    "user_id":165505,
+    "viewed_at":null,
+    "website":null,
+    "work_address_1":null,
+    "work_address_2":null,
+    "work_city":null,
+    "work_country":null,
+    "work_postal_code":null,
+    "work_state":null,
+    "company_name":null,
+    "full_name":"Unknown",
+    "predefined_contacts_tag_ids":[],
+    "deal_ids":[],
+    "image_thumb_url":"/images/thumb/missing.png",
+    "image_mobile_url":"/images/mobile/missing.png",
+    "work_address_google_maps_url":"http://maps.google.com/maps?q=%2C+%2C+%2C+++",
+    "predefined_contacts_tags":[],
+    "deals":[],
+    "user":{"id":165505, "first_name":"ramon", "last_name":"savinon"},
+    "lead_status":null,
+    "lead_source":null,
+    "custom_fields":{"custom_label_1109338":null, "custom_label_1109341":null, "custom_label_1109344":null}},
+    {"bounced":false,
+    "company_id":null,
+    "created_at":"2015/08/08 16:51:26 -0700",
+    "email":"rashad_anderson@white.info",
+    "email2":null,
+    "facebook_url":null,
+    "fax":null,
+    "first_name":null,
+    "home_address_1":null,
+    "home_address_2":null,
+    "home_city":null,
+    "home_country":null,
+    "home_email":null,
+    "home_phone":null,
+    "home_postal_code":null,
+    "home_state":null,
+    "id":1043404444,
+    "instant_message":null,
+    "last_name":"Unknown",
+    "linked_in_url":null,
+    "mobile":null,
+    "phone":null,
+    "position":null,
+    "summary":null,
+    "twitter":null,
+    "type":"Contact",
+    "unsubscribed":false,
+    "updated_at":"2015/08/08 16:51:26 -0700",
+    "user_id":165505,
+    "viewed_at":null,
+    "website":null,
+    "work_address_1":null,
+    "work_address_2":null,
+    "work_city":null,
+    "work_country":null,
+    "work_postal_code":null,
+    "work_state":null,
+    "company_name":null,
+    "full_name":"Unknown",
+    "predefined_contacts_tag_ids":[],
+    "deal_ids":[],
+    "image_thumb_url":"/images/thumb/missing.png",
+    "image_mobile_url":"/images/mobile/missing.png",
+    "work_address_google_maps_url":"http://maps.google.com/maps?q=%2C+%2C+%2C+++",
+    "predefined_contacts_tags":[],
+    "deals":[],
+    "user":{"id":165505, "first_name":"ramon", "last_name":"savinon"},
+    "lead_status":null,
+    "lead_source":null,
+    "custom_fields":{"custom_label_1109338":null, "custom_label_1109341":null, "custom_label_1109344":null}},
+    {"bounced":false,
+    "company_id":null,
+    "created_at":"2015/08/06 11:06:03 -0700",
+    "email":"asia_waters@larson.biz",
+    "email2":null,
+    "facebook_url":null,
+    "fax":null,
+    "first_name":null,
+    "home_address_1":null,
+    "home_address_2":null,
+    "home_city":null,
+    "home_country":null,
+    "home_email":null,
+    "home_phone":null,
+    "home_postal_code":null,
+    "home_state":null,
+    "id":1043113642,
+    "instant_message":null,
+    "last_name":"Unknown",
+    "linked_in_url":null,
+    "mobile":null,
+    "phone":null,
+    "position":null,
+    "summary":null,
+    "twitter":null,
+    "type":"Contact",
+    "unsubscribed":false,
+    "updated_at":"2015/08/06 11:06:03 -0700",
+    "user_id":165505,
+    "viewed_at":null,
+    "website":null,
+    "work_address_1":null,
+    "work_address_2":null,
+    "work_city":null,
+    "work_country":null,
+    "work_postal_code":null,
+    "work_state":null,
+    "company_name":null,
+    "full_name":"Unknown",
+    "predefined_contacts_tag_ids":[],
+    "deal_ids":[],
+    "image_thumb_url":"/images/thumb/missing.png",
+    "image_mobile_url":"/images/mobile/missing.png",
+    "work_address_google_maps_url":"http://maps.google.com/maps?q=%2C+%2C+%2C+++",
+    "predefined_contacts_tags":[],
+    "deals":[],
+    "user":{"id":165505, "first_name":"ramon", "last_name":"savinon"},
+    "lead_status":null,
+    "lead_source":null,
+    "custom_fields":{"custom_label_1109338":null, "custom_label_1109341":null, "custom_label_1109344":"East Elroyhaven"}}],
+ "pagination":{"page":1, "page_var":"page", "per_page":200, "pages":1, "total":78}}

data/spec/support/fixtures/person_custom_fields.json

@@ -0,0 +1,5 @@
+{"entries":
+  [{"created_at":"2015/08/05 16:33:11 -0700", "field_type":"numeric", "id":1109338, "is_required":false, "name":"age", "updated_at":"2015/08/05 16:33:11 -0700"},
+   {"created_at":"2015/08/05 16:33:22 -0700", "field_type":"text", "id":1109341, "is_required":false, "name":"fav_pokemon", "updated_at":"2015/08/05 16:33:22 -0700"},
+   {"created_at":"2015/08/05 16:33:50 -0700", "field_type":"text", "id":1109344, "is_required":false, "name":"nickname", "updated_at":"2015/08/05 16:33:50 -0700"}],
+ "pagination":{"page":1, "page_var":"page", "per_page":200, "pages":1, "total":3}}

data/spec/support/fixtures/users.json

@@ -0,0 +1,16 @@
+{"entries":
+  [{"account_id":70918,
+    "deleted_at":null,
+    "email":"ramon+4@wishpond.com",
+    "email2":null,
+    "email3":null,
+    "first_name":"ramon",
+    "id":165505,
+    "is_account_admin":true,
+    "last_name":"savinon",
+    "level":3,
+    "manager_id":null,
+    "avatar_thumb_url":null,
+    "api_key":"zZOj2w5SgTNZkwcQNkq",
+    "is_google_apps_enabled":false}],
+ "pagination":{"page":1, "page_var":"page", "per_page":200, "pages":1, "total":1}}

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: pipelinedeals-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- vaberay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+  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: webmock
+  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: sinatra
+  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: This gem is to be interact with te pipelinedeals api.
+email:
+- ramon@wishpond.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pipelinedeals/client.rb
+- lib/pipelinedeals/client/version.rb
+- pipelinedeals-client.gemspec
+- spec/client_spec.rb
+- spec/features/external_request_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_pipelinedeals.rb
+- spec/support/fixtures/create_person.json
+- spec/support/fixtures/error.json
+- spec/support/fixtures/people.json
+- spec/support/fixtures/person_custom_fields.json
+- spec/support/fixtures/users.json
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: To be used with Chatty Panda
+test_files:
+- spec/client_spec.rb
+- spec/features/external_request_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_pipelinedeals.rb
+- spec/support/fixtures/create_person.json
+- spec/support/fixtures/error.json
+- spec/support/fixtures/people.json
+- spec/support/fixtures/person_custom_fields.json
+- spec/support/fixtures/users.json