her-webmock 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99be1cb35146e5876a026f891fdd5dce984877ed
+  data.tar.gz: 3af30122077a500a2f6cd157215ff728c0068cf1
+SHA512:
+  metadata.gz: 511961e112fa0a37d007100174c69a997560616fa37de3ebcf99f09718759afaa275b7585337809fcb46833026c5ef7af5e0243c9093eb08ba83d41d1bd29a41
+  data.tar.gz: 7f6ec4890ce33dced99aa97011c973da6387fa1f73290aa19e2f2472d2ff7250278ae43490a81a32e6e8170b4a76e9cb88899fff62a77637cfde72eb69d2e743

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,3 @@
+language: ruby
+rvm:
+  - 2.1.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Octavian Neamtu
+
+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,97 @@
+# Her::WebMock
+
+Tired of hand-inputting paths and JSON hashes when Her is so sensible to use?  Her::WebMock is a useful gem for easy Her::Model request stubs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'her-webmock'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+In your spec_helper or initializer (or wherever you want to mock things) do:
+
+```ruby
+require 'her/webmock/model'
+
+::User.extend ::Her::WebMock::Model
+```
+
+where User is a Her::Model. Now you can easily stub the requests that you'd normally expect to
+be returned on User.find and User.all
+
+```ruby
+User.stub_find(User.new(id: 5, name: 'user'))
+# equivalent to
+stub_request("http://.../users/5").and_return("so much JSON string that includes id 5 and name 'user'")
+```
+
+```ruby
+# stub for .all
+User.stub_all([User.new(id: 5, name: 'user'), User.new(id: 6, name: "anon")])
+# passing extra params - these get passed to WebMock
+User.stub_all([User.new(id: 5, name: 'user')], query: hash_including({}), headers: { per_page: 12 }, metadata: { page: 1 })
+# adding additional data to the response
+User.stub_all([User.new(id: 5, name: 'user')], metadata: { page: 1, metadata: { additional: 'stuff' } })
+```
+
+You can also easily define your own stub method matchers:
+
+```ruby
+module Mocks
+  module User
+    include ::Her::WebMock::Model
+
+    def stub_for_resource_type_and_resource_id(issues, resource_type, resource_id)
+      query_params = {
+        'search' => {
+          'resource_id_eq' => resource_id,
+          'resource_type_eq' => resource_type
+        }
+      }
+
+      stub_all(issues, query_params: query_params)
+    end
+
+    ...
+
+User.extend Mocks::User
+```
+
+## Configuration
+
+If you expect default headers in all your requests, you can configure them in:
+
+```ruby
+Her::WebMock.configure do |config|
+  config.default_request_test_headers = { 'Authorization' => /Bearer .+/ }
+end
+```
+
+## TODO
+ * Test stub associations
+ * Support more association stubs
+ * test default_request_test_headers functionality
+ * make the stub methods included in a model just stubs that call out to the stub methods
+ * Break out the stub components
+
+## Development
+
+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/annkissam/her-webmock/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 @@
+require "bundler/gem_tasks"

data/bin/console

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

data/her-webmock.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'her/webmock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "her-webmock"
+  spec.version       = Her::WebMock::VERSION
+  spec.authors       = ["Octavian Neamtu"]
+  spec.email         = ["octavian.neamtu@annkissam.com"]
+
+  spec.summary       = %q{Easier request stubbing for Her::Model with webmock.}
+  spec.homepage      = "https://github.com/annkissam/her-webmock.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # 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_runtime_dependency "her"
+  spec.add_runtime_dependency "webmock"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/her/webmock.rb

@@ -0,0 +1,22 @@
+require "her/webmock/version"
+
+module Her
+  module WebMock
+    class Configuration
+      attr_accessor :default_request_test_headers
+
+      def initialize(options = {})
+        self.default_request_test_headers = {}
+      end
+    end
+
+    def self.configure
+      yield config
+      config.freeze
+    end
+
+    def self.config
+      @config ||= Configuration.new
+    end
+  end
+end

data/lib/her/webmock/model.rb

@@ -0,0 +1,138 @@
+require 'her/webmock'
+require 'webmock'
+require 'json'
+
+module Her
+  module WebMock
+    module Helper
+      def self.attributes_without_embedded_associations(klass, object)
+        attributes = object.respond_to?(:attributes) ? object.attributes.dup : object.dup
+
+        klass.associations.each do |type, association_metadata_ary|
+          association_metadata_ary.each do |association_metadata|
+            association = attributes.delete(association_metadata[:name])
+
+            attributes[association_metadata[:foreign_key]] = association.id if association
+          end
+        end
+
+        attributes
+      end
+
+      def self.request_params(options = {})
+        request_params = {}
+
+        request_params[:query] = options[:query]
+
+        headers_hash = default_headers.merge(options.fetch(:headers, {}))
+        request_params[:headers] = headers_hash unless headers_hash.empty?
+
+        request_params
+      end
+
+      def self.default_headers
+        WebMock.config.default_request_test_headers
+      end
+    end
+
+    module Model
+      include ::WebMock::API
+
+      def stub_associations(klass, object)
+        attributes = object.respond_to?(:attributes) ? object.attributes : object
+
+        klass.associations.each do |type, association_metadata_ary|
+          association_metadata_ary.each do |association_metadata|
+            association = attributes[association_metadata[:name]]
+
+            if association
+              case type
+              when :belongs_to
+                Object.const_get(association_metadata[:class_name]).stub_find(association)
+              else
+                # TODO
+                fail NotImplementedError
+              end
+            end
+          end
+        end
+      end
+
+      def stub_create(object, options = {})
+        model_class = self
+        attributes = object.is_a?(Her::Model) ? Helper.attributes_without_embedded_associations(model_class, object) : object
+
+        fail "Must pass in an object with an id attribute" unless attributes[:id]
+
+        if model_class.parsed_root_element
+          response = {
+            model_class.parsed_root_element => attributes
+          }
+        else
+          response = attributes
+        end
+
+        attributes_without_id = attributes.except(:id)
+
+        request_stub = stub_request(:post, model_class.use_api.base_uri + model_class.build_request_path(attributes_without_id)).
+          to_return(body: JSON.generate(response), status: 200)
+
+        request_params = Helper.request_params(options)
+        request_stub.with(request_params) unless request_params.empty?
+
+        if options[:stub_related]
+          stub_find(object)
+          stub_all([object])
+        end
+
+        stub_associations(model_class, object)
+
+        request_stub
+      end
+
+      def stub_find(object, options = {})
+        model_class = self
+        attributes = object.is_a?(Her::Model) ? Helper.attributes_without_embedded_associations(model_class, object) : object
+
+        if model_class.parsed_root_element
+          response = {
+            model_class.parsed_root_element => attributes
+          }
+        else
+          response = attributes
+        end
+
+        request_stub = stub_request(:get, model_class.use_api.base_uri + model_class.build_request_path(attributes)).
+          to_return(body: JSON.generate(response), status: 200)
+
+        request_params = Helper.request_params(options)
+        request_stub.with(request_params) unless request_params.empty?
+
+        stub_associations(model_class, object)
+
+        request_stub
+      end
+
+      def stub_all(collection, options = {})
+        model_class = self
+
+        collection_attributes = collection.map { |object| Helper.attributes_without_embedded_associations(model_class, object) }
+        response = {
+          model_class.pluralized_parsed_root_element => collection_attributes
+        }
+
+        response = options[:metadata].merge(response) if options[:metadata]
+
+        request_stub = stub_request(:get, model_class.use_api.base_uri + model_class.collection_path).
+          to_return(body: JSON.generate(response), status: 200)
+
+        request_params = Helper.request_params(options)
+        request_stub.with(request_params) unless request_params.empty?
+
+        collection.each { |object| stub_associations(model_class, object) }
+
+        request_stub
+      end
+    end
+  end
+end

data/lib/her/webmock/version.rb

@@ -0,0 +1,5 @@
+module Her
+  module WebMock
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: her-webmock
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Octavian Neamtu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: her
+  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: webmock
+  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.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: 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'
+description: 
+email:
+- octavian.neamtu@annkissam.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
+- her-webmock.gemspec
+- lib/her/webmock.rb
+- lib/her/webmock/model.rb
+- lib/her/webmock/version.rb
+homepage: https://github.com/annkissam/her-webmock.git
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Easier request stubbing for Her::Model with webmock.
+test_files: []