pipekit 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0ff8c19ce8cb4d0ec668801e0f97bc981a627cc
+  data.tar.gz: 4b6c505ab661d40acbb16b7c1cd48e082e02e1d8
+SHA512:
+  metadata.gz: 3a49869edcdfc81a14fd578778040276cbacf1a7d3e5c6286f05f6623b34f00f7cb9d794dad8e7d89ea550e17af5ef507613ce385330bb23d547ed95e57e6e18
+  data.tar.gz: 195663112064866b3027928bccf9ebacc8a6bed8e7e7017cfa59a24f0fcf37306ecc2c6d0a65d2d08c1fb1771c3d93895d9ad69be38d31c5862c553e6acf76ee

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+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 howeveririna@gmail.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 pipekit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 jafrog
+
+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,41 @@
+# Pipekit
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pipekit`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pipekit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pipekit
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/pipekit. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pipekit"
+
+# 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
+
+require "irb"
+IRB.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/lib/pipekit/configurable.rb

@@ -0,0 +1,46 @@
+require "yaml"
+require "active_support/inflector"
+require "active_support/core_ext/hash/indifferent_access"
+
+module Configurable
+  def config
+    self.class.config
+  end
+
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    def config_file_path
+      "./config/#{name.underscore}.yml"
+    end
+
+    def config
+      @config ||= load_config.with_indifferent_access
+    end
+
+    private
+
+    def load_config
+      config_hash = load_from_yaml
+
+      config_hash.default_proc = proc do |hash, key|
+        raise Configurable::KeyNotFoundError.new(key)
+      end
+
+      config_hash
+    end
+
+    def load_from_yaml
+      yaml = ERB.new(File.read(config_file_path)).result
+      YAML.load(yaml)
+    end
+  end
+
+  class KeyNotFoundError < StandardError
+    def initialize(key)
+      super("The key #{key} was not found in the configuration file")
+    end
+  end
+end

data/lib/pipekit/deal.rb

@@ -0,0 +1,9 @@
+module Pipekit
+  class Deal
+    include Repository
+
+    def get_by_person_id(person_id)
+      request.get("/#{Pipekit::Person.uri}/#{person_id}/#{self.class.uri}")
+    end
+  end
+end

data/lib/pipekit/note.rb

@@ -0,0 +1,5 @@
+module Pipekit
+  class Note
+    include Repository
+  end
+end

data/lib/pipekit/person.rb

@@ -0,0 +1,13 @@
+module Pipekit
+  class Person
+    include Repository
+
+    def get_by_email(email)
+      request.get("/#{uri}/find", term: email, search_by_email: 1)
+    end
+
+    def get_by_name(name)
+      request.get("/#{uri}/find", term: name)
+    end
+  end
+end

data/lib/pipekit/person_field.rb

@@ -0,0 +1,15 @@
+module Pipekit
+  class PersonField
+    include Repository
+
+    def get_by_id(id)
+      request.get("/#{uri}").select { |element| element["id"] == id }
+    end
+
+    def get_by_key(key)
+      custom_field_key = request.config["people_fields"][key] rescue nil
+      key = custom_field_key || key
+      request.get("/#{uri}").select { |element| element["key"] == key }
+    end
+  end
+end

data/lib/pipekit/repository.rb

@@ -0,0 +1,102 @@
+class ConfigNotSetError < Exception; end
+module Pipekit
+  module Repository
+
+    def initialize(request = Pipekit::Request.new)
+      @request = request
+    end
+
+    def all
+      request.get("/#{uri}")
+    end
+
+    # Public: Get all records from Pipedrive by **one** of the record's fields.
+    #
+    # options - A Hash with one key-value pair. Key is a field name and values is a field value.
+    #
+    # Examples
+    #
+    #   where(name: "John Doe")
+    #   where(github_username: "pipedriver")
+    #   where(id: 123)
+    #
+    # Returns array of Hashes.
+    def where(options)
+      send("get_by_#{options.keys.first}", options.values.first)
+    end
+
+    # Public: Get the first record by **one** field from Pipedrive.
+    #
+    # options - A Hash with one key-value pair. Key is a field name and values is a field value.
+    #
+    # Examples
+    #
+    #   find_by(name: "John Doe")
+    #   find_by(github_username: "pipedriver")
+    #   find_by(id: 123)
+    #
+    # Returns a Hash or nil if none found.
+    def find_by(options)
+      where(options).first
+    end
+
+    # Public: Create a record on Pipedrive.
+    #
+    # fields - fields for the record.
+    #
+    # Examples
+    #
+    #   create({name: "John Doe", deal_id: 123})
+    #
+    # Returns nothing.
+    def create(fields)
+      request.post("/#{uri}", fields)
+    end
+
+    # Public: Updates a record on Pipedrive.
+    #
+    # fields - fields for the record.
+    #
+    # Examples
+    #
+    #   update(123, {name: "Jane Doe"})
+    #
+    # Returns nothing.
+    def update(id, fields)
+      request.put("/#{uri}/#{id}", fields)
+    end
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      attr_accessor :uri
+    end
+
+    private
+
+    attr_reader :request
+
+    def method_missing(method_name, *args)
+      super unless method_name =~ /^get_by/
+
+      field = method_name.to_s.gsub("get_by_", "")
+      get_by_field(field: field, value: args[0])
+    end
+
+    def get_by_id(id)
+      [request.get("/#{uri}/#{id}")]
+    end
+
+    def get_by_field(field:, value:)
+      result = request.search_by_field(type: uri, field: field, value: value)
+      result.map { |item| get_by_id(item["id"]) }.flatten
+    end
+
+    def uri
+      class_name = self.class.to_s.split("::").last
+      "#{class_name.downcase}s"
+    end
+  end
+end

data/lib/pipekit/request.rb

@@ -0,0 +1,69 @@
+require "httparty"
+
+module Pipekit
+  class Request
+    include HTTParty
+
+    PIPEDRIVE_URL = "https://api.pipedrive.com/v1"
+
+    base_uri PIPEDRIVE_URL
+    format :json
+
+    # Public: Pipedrive /searchField API call.
+    #
+    # type - Type of the field:
+    #        :person - person fields
+    #        :deal - deal fields
+    # field - The name of the field.
+    #         If it's the custom field the id of the field should be stored in `config/pipedrive.yml`.
+    # value - The value of the field.
+    #
+    # Examples
+    #
+    #   search_by_field(type: :person, field: :cohort, value: 119)
+    #   search_by_field(type: :person, field: :github_username, value: "octocat")
+    #
+    # Returns an array of Hashes or nil.
+    def search_by_field(type:, field:, value:)
+      options = {field_type: "#{type}Field",
+                 field_key: config["#{type.to_s.pluralize}_fields"][field],
+                 return_item_ids: true}
+
+      get("/searchResults/field", options.merge(term: value))
+    end
+
+    def get(uri, query = {})
+      result_from self.class.get(uri, options(query: query))
+    end
+
+    def put(uri, body)
+      result_from self.class.put(uri, options(body: body))
+    end
+
+    def post(uri, body)
+      result_from self.class.post(uri, options(body: body))
+    end
+
+    private
+
+    def config
+      Pipekit.config
+    end
+
+    def result_from(response)
+      return nil unless success?(response)
+      response.parsed_response["data"]
+    end
+
+    def success?(response)
+      response.parsed_response["success"]
+    end
+
+    def options(query: {}, body: {})
+      {
+        query: {api_token: config[:api_token] }.merge(query),
+        body: body
+      }
+    end
+  end
+end

data/lib/pipekit/version.rb

@@ -0,0 +1,3 @@
+module Pipekit
+  VERSION = "0.2.0"
+end

data/lib/pipekit.rb

@@ -0,0 +1,33 @@
+require "pipekit/configurable"
+require "httparty"
+require "pipekit/version"
+require "pipekit/request"
+require "pipekit/repository"
+require "pipekit/person"
+require "pipekit/deal"
+require "pipekit/person_field"
+require "pipekit/note"
+
+module Pipekit
+  include Configurable
+
+  # Define a path to Pipedrive config file
+  #
+  # Example:
+  #
+  # Pipekit.config_file_path = File.join("config", "pipedrive.yml")
+  class << self
+    attr_writer :config_file_path
+
+    def config_file_path
+      @config_file_path || raise_config_error
+    end
+
+    def raise_config_error
+      raise ConfigNotSetError, "You need to create a yaml file with your Pipedrive config and set the path to the file using `Pipedrive.config_file_path = 'path/to/file.yml'`"
+    end
+  end
+
+  ConfigNotSetError = Class.new(Exception)
+end
+

data/pipekit.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pipekit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pipekit"
+  spec.version       = Pipekit::VERSION
+  spec.authors       = ["jafrog", "pitchinvasion", "spike01"]
+  spec.email         = ["irina@makersacademy.com", "leo@makersacademy.com", "spike@makersacademy.com"]
+
+  spec.summary       = %q{Pipedrive API client for Ruby.}
+  spec.description   = %q{Pipedrive API client for Ruby.}
+  spec.homepage      = "https://github.com/makersacademy/pipekit"
+  spec.license       = "MIT"
+
+  # 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 "httparty"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: pipekit
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- jafrog
+- pitchinvasion
+- spike01
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-29 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: activesupport
+  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.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: '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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: 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'
+description: Pipedrive API client for Ruby.
+email:
+- irina@makersacademy.com
+- leo@makersacademy.com
+- spike@makersacademy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pipekit.rb
+- lib/pipekit/configurable.rb
+- lib/pipekit/deal.rb
+- lib/pipekit/note.rb
+- lib/pipekit/person.rb
+- lib/pipekit/person_field.rb
+- lib/pipekit/repository.rb
+- lib/pipekit/request.rb
+- lib/pipekit/version.rb
+- pipekit.gemspec
+homepage: https://github.com/makersacademy/pipekit
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Pipedrive API client for Ruby.
+test_files: []