pipekit-webmock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfb40dd8031997d9edf6dd6bb49d2ce93a908931
+  data.tar.gz: b28590e950ccafa48c9ee6efdc7700014b8e7ba7
+SHA512:
+  metadata.gz: b93a386d84f044c7a45a73685834bb5e6c8c5973a5b5541ef7f529fd45dc60ecd517e2246e65e2047cf45e4f92f31cbaead1c1c0ddd85c55297280ea6db492be
+  data.tar.gz: 32d0ce8a820dd49ff7ae014ad0312daaea027b43f118beb2c4e5d1556c201d75d24a81215239e4912a8e8b834c16c166d14e8491988cfe1ddd3783b58d203acf

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team 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. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pipekit-webmock.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,116 @@
+# pipekit-webmock
+
+This is a [WebMock](https://github.com/bblimke/webmock) extension to stub requests to [Pipedrive](http://www.pipedrive.com) with the [pipekit](https://github.com/makersacademy/pipekit) gem.
+
+It provides a `stub_pipedrive_request` method and readable error messages for unregistered requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pipekit-webmock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pipekit-webmock
+
+## Usage
+
+To use `pipekit` you will need a dummy Pipedrive config for your tests. Create a file with Pipedrive field mapping in `spec/support/config.yml`. Then add the following to your `spec_helper`:
+
+```ruby
+# Dummy config data
+Pipekit.config_file_path = File.join(File.dirname(__FILE__), "support", "config.yml")
+```
+
+To stub requests to Pipedrive use `stub_pipedrive_request` method where you would normally use `WebMock`'s `stub_request` with the following params:
+
+- `resource` - what "entity" is request made to. Possible values are:
+  - `:person`
+  - `:deal`
+  - `:note`
+  - `:personField`
+- `action`:
+  - `:get` - Stubs a `GET` request to get resource by id or a query string.
+  - `:create` - Stubs a `POST` request to create a resource.
+  - `:update` - Stubs a `PUT` request to update the resource. `params` hash should include `id`.
+  - `:search` - Stubs a `GET` request to the `searchResults` endpoint.
+  - `:find_by_person_id` - Only for the `deal` resource. Stubs a `GET` request to `persons/:id/deals` on Pipedrive.
+  - `:find_by_email` - Only for the `person` resource. Stubs a `GET` request to `persons` with `search_by_email=1` query param on Pipedrive.
+  - `:find_by_name` - Only for the `person` resource. Stubs a `GET` request to `persons` on Pipedrive.
+- `params` - a hash of parameters. Could be either a query string (for `GET` requests) or a body (for `POST` and `PUT`) requests. For `update` action must include `:id` (as a symbol). Custom Pipedrive fields **don't** have to be converted to their Pipedrive ids.
+- `response` - what stubbed request should return. Note that most `GET` requests return an array, even if there's only one match.
+
+## Examples
+
+```ruby
+stub_pipedrive_request(
+  resource: :person,
+  action: :create,
+  params: {
+    "email" => "octocat@github.com",
+    "name" => "Octocat",
+    "middle_name" => "Purr" # custom Pipedrive field
+  },
+  response: {id: 123}
+)
+
+stub_pipedrive_request(
+  resource: :deal,
+  action: :update,
+  params: {
+    id: 123,
+    stage: "1st Contact"
+  },
+  response: {id: 123}
+)
+
+stub_pipedrive_request(
+  resource: :person,
+  action: :find_by_email,
+  params: {
+    email: "octocat@gmail.com"
+  }
+  response: [{id: 123}] # notice the array
+)
+
+stub_pipedrive_request(
+  resource: :deal,
+  action: :find_by_person_id,
+  params: {
+    person_id: 123
+  },
+  response: [{id: 345}]
+)
+
+stub_pipedrive_request(
+  resource: :person,
+  action: :search,
+  params: {
+    "Middle name" => "Purr" # custom Pipedrive field
+  },
+  response: [{id: 123}]
+)
+```
+
+## 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-webmock. 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/webmock"
+
+# 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/webmock.rb

@@ -0,0 +1,8 @@
+require "pipekit"
+require "pipekit/webmock/version"
+require "pipekit/webmock/api"
+
+module Pipekit
+  module WebMock
+  end
+end

data/lib/pipekit/webmock/api.rb

@@ -0,0 +1,115 @@
+# Public: An extension over Webmock's `stub_request`.
+# Allows to stub specifically requests to Pipedrive.
+#
+# Examples
+#
+#   # in your spec file or spec_helper.rb
+#
+#   include Pipekit::Webmock::API
+#
+# before do
+#   stub_pipedrive_request(
+#     resource: :person,
+#     action: :create,
+#     params: {name: "Morty"},
+#     response: {id: 123}
+#   )
+# end
+require "webmock"
+require "pipekit/webmock/errors"
+
+module Pipekit
+  module WebMock
+    module API
+      extend self
+
+      def self.included(mod)
+        if const_defined?("::WebMock::NetConnectNotAllowedError")
+          ::WebMock.send(:remove_const, :NetConnectNotAllowedError)
+          ::WebMock.send(:const_set, :NetConnectNotAllowedError, Pipekit::WebMock::UnregisteredPipedriveRequestError)
+        end
+      end
+
+      def stub_pipedrive_request(resource:, action:, params:, response: nil)
+        StubRequest.new(resource).stub_request_and_response(action, params, response)
+      end
+
+      class StubRequest
+        include ::WebMock::API
+
+        def initialize(resource)
+          @request = Pipekit::Request.new(resource)
+        end
+
+        def stub_request_and_response(action, params, response)
+          request = self.send("stub_#{action}_request", params)
+          request.and_return(status: 200, body: {"data" => response, "success" => true}.to_json) if response
+          request
+        end
+
+        private
+
+        def stub_create_request(params)
+          stub_request(:post, resource_uri).with(body: body_from(params))
+        end
+
+        def stub_update_request(params)
+          id = params.delete(:id)
+          stub_request(:put, resource_uri(id)).with(body: body_from(params))
+        end
+
+        def stub_get_request(params)
+          id = params.delete(:id)
+          uri = "#{resource_uri(id)}&#{body_from(pagination_params)}"
+          stub_request(:get, uri)
+        end
+
+        def stub_search_request(params)
+          field = params.keys.first
+          value = params[field]
+          query = @request.search_by_field_query(field, value).merge(pagination_params)
+          uri = "#{Pipekit::Request::PIPEDRIVE_URL}/searchResults/field?#{api_token_param}&#{body_from(query)}"
+          stub_request(:get, uri)
+        end
+
+        def stub_find_by_person_id_request(params)
+          person_id = params.delete(:person_id)
+          stub_request(:get, "#{Pipekit::Request::PIPEDRIVE_URL}/persons/#{person_id}/deals?#{api_token_param}&#{body_from(pagination_params)}")
+        end
+
+        def stub_find_by_email_request(params)
+          email = params.delete(:email)
+          stub_request(:get, "#{resource_uri("find")}&#{body_from(pagination_params)}&term=#{email}&search_by_email=1")
+        end
+
+        def stub_find_by_name_request(params)
+          name = params.delete(:name)
+          stub_request(:get, "#{resource_uri("find")}&#{body_from(pagination_params)}&term=#{name}")
+        end
+
+        def resource_uri(id = "")
+          "#{Pipekit::Request::PIPEDRIVE_URL}#{@request.uri(id)}?#{api_token_param}"
+        end
+
+        def body_from(params)
+          HTTParty::HashConversions.to_params(@request.parse_body(params))
+        end
+
+        def pagination_params
+          {
+            limit: @request.pagination_limit,
+            start: 0
+          }
+        end
+
+        def start
+          0
+        end
+
+        def api_token_param
+          "api_token=#{Config.fetch(:api_token)}"
+        end
+      end
+    end
+  end
+end

data/lib/pipekit/webmock/errors.rb

@@ -0,0 +1,36 @@
+require "rack"
+require "webmock"
+
+module Pipekit
+  module WebMock
+    class UnregisteredPipedriveRequestError < StandardError
+      WebMockNetConnectNotAllowedError = ::WebMock::NetConnectNotAllowedError unless const_defined?(:WebMockNetConnectNotAllowedError)
+
+      def initialize(request_signature)
+        return WebMockNetConnectNotAllowedError.new(request_signature) unless request_signature.uri.hostname == "api.pipedrive.com"
+
+        resource = request_signature.uri.path.split("/").last[0..-2]
+        query = request_signature.uri.query
+        body = request_signature.body
+        text = [
+          "Unregistered request to Pipedrive: #{request_signature.uri}",
+          "with params:",
+          extract_params(resource, query),
+          "and body:",
+          extract_params(resource, body),
+          "="*60
+        ].compact.join("\n\n")
+        super(text)
+      end
+
+      def extract_params(resource, query)
+        params = Rack::Utils.parse_nested_query(query)
+        params.reduce({}) do |result, (field, value)|
+          field = Config.field_name(resource, field)
+          value = Config.field_value(resource, field, value)
+          result.tap { |result| result[field] = value }
+        end.map { |k, v| "#{k}: #{v}" }.join("\n")
+      end
+    end
+  end
+end

data/lib/pipekit/webmock/version.rb

@@ -0,0 +1,5 @@
+module Pipekit
+  module WebMock
+    VERSION = "0.1.0"
+  end
+end

data/pipekit-webmock.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pipekit/webmock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pipekit-webmock"
+  spec.version       = Pipekit::WebMock::VERSION
+  spec.authors       = ["jafrog"]
+  spec.email         = ["howeveririna@gmail.com"]
+
+  spec.summary       = %q{WebMock extension for requests to Pipedrive}
+  spec.description   = %q{Registers a `stub_pipedrive_request` method and makes unregistered request error messages more readable}
+  spec.homepage      = "https://github.com/makersacademy/pipekit-webmock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "webmock", "~>2.1"
+  spec.add_dependency "pipekit", "~>1.2"
+  spec.add_dependency "rack"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: pipekit-webmock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jafrog
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pipekit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: 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: Registers a `stub_pipedrive_request` method and makes unregistered request
+  error messages more readable
+email:
+- howeveririna@gmail.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/webmock.rb
+- lib/pipekit/webmock/api.rb
+- lib/pipekit/webmock/errors.rb
+- lib/pipekit/webmock/version.rb
+- pipekit-webmock.gemspec
+homepage: https://github.com/makersacademy/pipekit-webmock
+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: WebMock extension for requests to Pipedrive
+test_files: []