stubsvc 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 365970a5c55f1b31d4a056e34aa48361691881e3
+  data.tar.gz: ad5f8bb7bdbfe5d429ae940f3cf6f350ced92ef9
+SHA512:
+  metadata.gz: 9bfa0cfb56edae1be4a996ba474c4c24b5c3983dc59e883ff746a7508baf9dacd28ebf5f438a8528f03f9662a776f6c6e4bcb324c49f3b74016da32f3533f9a2
+  data.tar.gz: 518f79ba958809cb894055a63d9fb0b7cb19faeacd7ddfa935e098bcfe3f04bb724cbce076dfb41f4fc01ec5f9c0884874f5e2018bfa7106ad03ec49076b47ee

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,69 @@
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - '**/*.gemspec'
+    - '**/*.podspec'
+    - '**/*.jbuilder'
+    - '**/*.rake'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Capfile'
+    - '**/Guardfile'
+    - '**/Podfile'
+    - '**/Thorfile'
+    - '**/Vagrantfile'
+  Exclude:
+    - 'vendor/**/*'
+    - 'stubs/**/*'
+
+# Checks formatting of special comments
+CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+
+########################################
+# Style Cops
+
+Style/Documentation:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+########################################
+# Lint Cops
+
+Lint/Eval:
+  Enabled: false
+
+########################################
+# Metrics Cops
+
+Metrics/LineLength:
+  Max: 110
+
+Metrics/MethodLength:
+  CountComments: false # count full line comments?
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,115 @@
+# Stubsvc
+
+**Version: 0.1.1**
+
+A Ruby gem that makes it easy to stub out calls to external web services using Webmock.
+
+Many applications are service-oriented or distributed in some way. Testing can be problematic in such an environment. `Stubsvc` makes it easy for unit tests to stub calls to external services, wrapping the Webmock `stub_request` method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stubsvc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stubsvc
+
+## Usage
+
+We've only tested using RSpec. However it may work just fine with Minitest, Test::Unit or others. Please let us know your results and pull requests are always welcome.
+
+### Configuration
+
+Configure your external services using environment variables as follows:
+
+    SVC_BASE_URI='http://localhost:5000/api/v4'
+
+Where `SVC` in the variable name above is the symbol you will use for your service, and the value points to the base URI for the particular service you are testing.
+
+For example, let's say I have a file service that handles uploads and downloads and all things file-related. I could define the environment variable as follows:
+
+    FS_BASE_URI='http://localhost:5000/api/v4'
+
+We recommend using Brandon Keeper's [dotenv](https://github.com/bkeepers/dotenv) gem for defining your base URIs.
+
+### Stubbing
+
+There are two ways to stub a service call:
+
+1. `Stubsvc.stub_action`
+2. `Stubsvc.stub_verb`
+
+#### `stub_action`
+
+`Stubsvc.stub_action` is for Rails [ActiveResource](https://github.com/rails/activeresource) type actions which accepts the following arguments:
+
+    Stubsvc.stub_action(service, action, resource, return_hash, status)
+
+* service - Lowercase symbol matching the environment variable defined above minus `_BASE_URI`
+* action - One of `:index, :show, :create, :update, :destroy, :where, :find`
+* resource - Symbol representing the remote resource. It must be snake-cased. For example, if the resource is `RootFolder`, the symbol would be `:root_folder`
+* return_hash - (optional) A hash representation of the JSON data you want returned for this call. If you don't care what gets returned and leave this argument out, it will default to `"{}"`
+* status - (optional) The HTTP status code that should be returned. Defaults to 200
+
+#### `stub_verb`
+
+`Stubsvc.stub_verb` is for stubbing standard HTTP verbs which accepts the following arguments:
+
+    Stubsvc.stub_verb(service, http_verb, uri, return_hash, status)
+
+* service - Lowercase symbol matching the environment variable defined above minus `_BASE_URI`
+* http_verb - One of `:get, :post, :put, :delete`
+* uri - A full or partial URI. It can be a regular expression or a string.
+* return_hash - (optional) A hash representation of the JSON data you want returned for this call. If you don't care what gets returned and leave this argument out, it will default to `"{}"`
+* status - (optional) The HTTP status code that should be returned. Defaults to 200
+
+### RSpec Example
+
+Let's say I have a model called `Article`. Whenever an `Article` instance is created it automatically creates a `Folder` instance by calling my external file service.
+
+We want to unit test the `create` method for `ArticlesController`, without having to fire up the external service. We can stub out the call to the file service `Folder.create` method like this:
+
+    RSpec.describe ArticlesController, type: :controller do
+      let(:valid_params) do 
+        {
+          article: {
+            name: 'Test Article'
+          }
+        } 
+      end
+
+      it 'persists an Article instance' do
+        Stubsvc.stub(:fs, :post, :folder, valid_params.merge(id: 1), 201)
+        expect do
+          post :create, valid_params
+        end.to change(Article, :count).by(1)
+      end
+    end
+
+This effectively stubs the `POST` call to `http://localhost:5000/api/v4/folders` to simply return this JSON:
+
+    {"article":{"name":"Test Article","id":1}}
+
+...with a status of `201`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/stubsvc/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,16 @@
+require 'bundler/gem_tasks'
+begin
+  require 'midwire_common/rake_tasks'
+rescue StandardError => e
+  puts(">>> Can't load midwire_common/rake_tasks.")
+  puts(">>> Did you 'bundle exec'?: #{e.message}")
+  exit
+end
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  puts 'No RSpec for you!'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stubsvc"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/stubsvc/stubber.rb

@@ -0,0 +1,71 @@
+require 'webmock'
+require 'oj'
+require 'active_support/core_ext/string/inflections'
+
+module Stubsvc
+  class Stubber
+    include WebMock::API
+
+    attr_reader :service
+
+    def initialize(service)
+      @service = service
+    end
+
+    def stub_action(action, resource, return_hash = {}, status = 200)
+      http_verb = verb_from_action(action)
+      regex = regex_for_action(resource, action, return_hash)
+      stub_request(http_verb, regex).to_return(
+        status: status.to_i,
+        body: Oj.dump(return_hash)
+      )
+    end
+
+    def stub_verb(verb, uri, return_hash = {}, status = 200)
+      http_verb = verb_from_action(verb)
+      pattern = "#{base_uri}#{uri}"
+      stub_request(http_verb, pattern).to_return(
+        status: status.to_i,
+        body: Oj.dump(return_hash)
+      )
+    end
+
+    def base_uri
+      return @base_uri if @base_uri
+      env_key = "#{service.upcase}_BASE_URI"
+      @base_uri = ENV.fetch(env_key).sub(%r{/+$}, '')
+    end
+
+    private
+
+    def verb_from_action(action)
+      case action.to_sym
+      when :show, :index, :where, :find, :get then :get
+      when :create, :post then :post
+      when :update, :put then :put
+      when :destroy, :delete then :delete
+      else
+        fail("Unknown action or http verb specified: '#{action}'")
+      end
+    end
+
+    def regex_for_action(item_type, action, return_hash = {})
+      pattern = "#{base_uri}/#{item_type.to_s.pluralize.downcase}"
+      if requires_id_in_path?(action)
+        pattern << "/#{return_hash.fetch(:id, 1)}*"
+      else
+        pattern << '*'
+      end
+      Regexp.new(pattern)
+    end
+
+    def requires_id_in_path?(action)
+      case action.to_sym
+      when :index, :create, :where, :post then false
+      when :show, :destroy, :update, :find, :put, :delete then true
+      else
+        fail("Can't figure out if the path contains an id: '#{action}'")
+      end
+    end
+  end
+end

data/lib/stubsvc/version.rb

@@ -0,0 +1,3 @@
+module Stubsvc
+VERSION = "0.1.1"
+end

data/lib/stubsvc.rb

@@ -0,0 +1,19 @@
+require 'stubsvc/version'
+
+module Stubsvc
+  class << self
+    def root
+      Pathname.new(File.dirname(__FILE__)).parent
+    end
+
+    def stub_action(service, action, resource, return_hash, status, stubber = Stubber.new(service))
+      stubber.stub_action(action, resource, return_hash, status)
+    end
+
+    def stub_verb(service, verb, uri, return_hash, status, stubber = Stubber.new(service))
+      stubber.stub_verb(verb, uri, return_hash, status)
+    end
+  end
+
+  autoload :Stubber,              'stubsvc/stubber'
+end

data/stubsvc.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stubsvc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stubsvc'
+  spec.version       = Stubsvc::VERSION
+  spec.authors       = ['Chris Blackburn']
+  spec.email         = ['205abc7e@opayq.com']
+
+  spec.summary       = 'Stub out calls to external web services.'
+  spec.description   = <<-stop
+    A Ruby gem that makes it easy to stub out calls to external web services using Webmock.
+  stop
+  spec.homepage      = ''
+
+  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_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rest-client', '~> 1.8'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+
+  spec.add_dependency 'midwire_common', '~> 0.1.16'
+  spec.add_dependency 'webmock', '~> 1.22'
+  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'oj', '~> 2.12'
+  spec.add_dependency 'rack', '~> 1.6'
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: stubsvc
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Chris Blackburn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: 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-nav
+  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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: midwire_common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.16
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: |2
+      A Ruby gem that makes it easy to stub out calls to external web services using Webmock.
+email:
+- 205abc7e@opayq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stubsvc.rb
+- lib/stubsvc/stubber.rb
+- lib/stubsvc/version.rb
+- stubsvc.gemspec
+homepage: ''
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Stub out calls to external web services.
+test_files: []