mocking_bird 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6b4da41969a3b859d95426bcf785a00fd03892b
+  data.tar.gz: 246ba452a26416f616b58f639c25b98efefce80a
+SHA512:
+  metadata.gz: fa848b794f9fea7e4d0d575872be253325a3b7d38fa312108f093d9f8c6ac3c5255aa5abd6b4ed7731e4826fa5cfc3bb62400021b76cc9c6d0091c277c00517d
+  data.tar.gz: 14d8effa82872a9230c63aa7bfebfe212c974edbb6a77595fbcc27f0682d682bc78b03363b83c20b105cbe9851073c12e03d19337b50e49bbf5593606a336ea2

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Brandon Sislow
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brandon Sislow
+
+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,160 @@
+# MockingBird
+
+This is a singleton class that helps auto load json_api_client_mocks.
+
+Pain point:
+Setting up client mocks for json_api_client tests can be messy with situations like:
+
+```ruby
+MyApi::Client::User.set_test_results([some data...], {<some conditions...>)
+MyApi::Client::User.set_test_results([some data...], {<some conditions...>)
+MyApi::Client::User.set_test_results([some data...], {<some conditions...>)
+MyOtherApi::Client::Customer.set_test_results([some data...], {<some conditions...>)
+MyOtherApi::Client::Customer.set_test_results([some data...], {<some conditions...>)
+MyOtherApi::Client::Customer.set_test_results([some data...], {<some conditions...>)
+```
+Placing this anywhere is ugly and time consuming.
+
+MockingBird attempts to combine this into a more fixture-like convention by using the file structure of your
+mocks to build client based test results that are accessible, or just trying to mimic fixtures.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mocking_bird'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mocking_bird
+
+## Usage
+
+#### File System Structure
+
+In your mock directory you would create the following structure:
+
+```
+|
+|-mocks
+  |-my_api
+    |-customer
+      create.yml
+      delete.yml
+      read.yml
+      update.yml
+    |-user
+      create.yml
+      delete.yml
+      read.yml
+      update.yml
+  |-my_other_api
+      |-order
+        create.yml
+        delete.yml
+        read.yml
+        update.yml
+      |-invocie
+        create.yml
+        delete.yml
+        read.yml
+        update.yml
+```
+
+This will load mocks for `MyApi::Client::Customer, MyApi::Client::User, MyOtherApi::Client::Order, and MyOtherApi::Client::Invoice`
+The mock files are grouped by action, but you can name them anything and they will be accessible by this actions(shown later).
+
+**currently only YAMl files are accepted, with JSON coming soon.**
+
+#### Mock File Structure
+
+The file structure for each mock file is:
+
+```yaml
+# user/create.yml
+<mock_name>:
+  conditions:
+      name: 'test_uers'
+    response:
+      id: 1
+      name: 'test_uers'
+```
+
+Example:
+
+```yaml
+# my_api/users/create.yml
+test_user:
+  conditions:
+    name: 'test_uers'
+    contact: 'test user'
+    email_address: 'test@test.com'
+    phone_number: '2062222222'
+    address_id: nil
+    credit_cards: []
+    address:
+      address_line1: '111 test ave'
+      addresS_line2: ''
+      city: 'Seattle'
+      state: 'WA'
+      count: nil
+      postal_code: '98109'
+  results:
+    id: 1
+    name: 'test_uers'
+    contact: 'test user'
+    email_address: 'test@test.com'
+    phone_number: '2062222222'
+    address_id: nil
+    credit_cards: []
+    address:
+      id: 1
+      address_line1: '111 test ave'
+      addresS_line2: ''
+      city: 'Seattle'
+      state: 'WA'
+      count: nil
+      postal_code: '98109'
+```
+
+**Note:** MockingBird looks for `conditions:` and `:results` to set up the mocks properly. It will fail without them.
+
+
+#### Building the mocks
+
+Setting up the mocks is done by calling
+
+```ruby
+MockingBird::setup_mocks(:path => Rails.root.join('test','mocks')
+```
+
+#### Fetching mock data
+
+Fetching the conditions and results you've set up is done by calling on MockingBird::Mocker:
+
+```ruby
+# get the test user mock
+MockingBird::Mocker.my_api.user.create.test_user
+# Hash (2 element(s))
+#   conditions => <HashWithIndifferntAccess> - your conditions for test_user in create.yml file
+#   results    => <HashWithIndifferntAccess> - your results for test_user in create.yml file
+MockingBird::Mocker.my_other_api.invoice.create.invoice_1
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mocking_bird/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
+=======
+mocking_bird
+============
+
+Mock manager for json_api_client_mocks
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/atlassian-ide-plugin.xml

@@ -0,0 +1,5 @@
+<atlassian-ide-plugin>
+  <project-configuration id="1">
+    <servers id="2" />
+  </project-configuration>
+</atlassian-ide-plugin>

data/lib/mocking_bird.rb

@@ -0,0 +1,8 @@
+require "mocking_bird/version"
+
+module MockingBird
+  autoload :Mocker, 'mocking_bird/mocker'
+  autoload :Flock, 'mocking_bird/flock'
+  autoload :Bird, 'mocking_bird/bird'
+  autoload :Mock, 'mocking_bird/mock'
+end

data/lib/mocking_bird/bird.rb

@@ -0,0 +1,52 @@
+require_relative 'mock'
+module MockingBird
+
+  class Bird
+
+    attr_accessor :mocks, :service, :klass
+
+    def initialize(opts = {})
+      @service = opts.fetch(:service)
+      @path    = opts.fetch(:path)
+      @klass   = @path.split("/").last.classify
+      @mocks   = {}
+
+      load_actions if @path.present?
+    end
+
+    def client_klass
+      @client_klass ||= "#{@service}::Client::#{@klass}".constantize
+    end
+
+    private
+
+    def load_actions
+      regex = File.join(@path,'*.yml')
+      Dir.glob(regex).each do | mock_file |
+        load_mocks(mock_file)
+      end
+    end
+
+    def load_mocks(mock_file)
+      action = File.basename(mock_file, ".*")
+      mock = Mock.new(mock_file, client_klass)
+      @mocks[action.downcase.to_sym] = mock
+    end
+
+    def method_missing(method, *args, &block)
+      if match = method.to_s.match(/^(.*)=$/)
+        raise NoMethodError
+      elsif has_mock?(method)
+        @mocks[method]
+      else
+        raise NoMethodError
+      end
+    end
+
+    def has_mock?(type)
+      @mocks.has_key? type
+    end
+
+
+  end
+end

data/lib/mocking_bird/flock.rb

@@ -0,0 +1,43 @@
+require_relative 'bird'
+module MockingBird
+  class Flock
+    attr_accessor :service, :birds
+
+    def initialize(path = '')
+      @birds = {}
+      @path   = path
+      @service = path.split("/").last.classify
+      load if @path.present?
+    end
+
+    private
+
+    def load
+      Dir.entries(@path).each do |dir|
+        spawn_birds(dir)
+      end
+    end
+
+    def spawn_birds(dir)
+      full_path = File.join(@path,dir)
+      if File.directory?(full_path) && dir != ".." && dir != "."
+        bird = Bird.new(:service => @service, :path => full_path)
+        @birds[bird.klass.downcase.to_sym] = bird
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      if match = method.to_s.match(/^(.*)=$/)
+        raise NoMethodError
+      elsif bird = has_bird?(method)
+        @birds[method]
+      else
+        raise NoMethodError
+      end
+    end
+
+    def has_bird?(klass)
+      @birds.has_key?(klass)
+    end
+  end
+end

data/lib/mocking_bird/mock.rb

@@ -0,0 +1,48 @@
+require 'yaml'
+module MockingBird
+  class Mock
+    attr_accessor :mock_set
+
+    def initialize(file, klass)
+      @file = file
+      @mock_set = {}
+      @klass = klass
+      load_mock if @file.present?
+    end
+
+
+    private
+
+    def load_mock
+      case File.extname(@file)
+        when '.yml'  then load_yaml
+        else nil
+      end
+    end
+
+    def load_yaml
+      objects = YAML::load_file(@file)
+      objects = objects.with_indifferent_access if objects.present?
+      Hash(objects|| nil).each do |k,v|
+        @mock_set[k.to_sym] = @klass.set_test_results(v[:results],v[:conditions]).first if v[:results] && v[:conditions]
+      end
+      @mock_set
+    end
+
+    def method_missing(method, *args, &block)
+      if match = method.to_s.match(/^(.*)=$/)
+        raise NoMethodError
+      elsif has_mock?(method)
+        @mock_set[method]
+      else
+        raise NoMethodError
+      end
+    end
+
+    def has_mock?(name)
+      @mock_set.has_key?(name.to_sym)
+    end
+
+
+  end
+end

data/lib/mocking_bird/mocker.rb

@@ -0,0 +1,47 @@
+require_relative 'flock'
+module MockingBird
+  class Mocker
+    cattr_accessor :path, :flocks
+
+    class << self
+      def setup_mocks(options = {})
+        # iterate over mocks and create birds in teh flock
+        @flocks = {}
+        @path = options.fetch(:path, default_directory)
+        load_mocks if @path
+      end
+
+      def load_mocks
+        Dir.entries(@path).each do |dir|
+
+          full_path = File.join(@path,dir)
+          if File.directory?(full_path) && dir != ".." && dir != "."
+            flock = Flock.new(full_path)
+            @flocks[flock.service.downcase.to_sym] = flock
+          end
+        end
+      end
+
+      private
+
+      def default_directory
+        Rails.root.join('test','mocks')
+      end
+
+      def method_missing(method, *args, &block)
+        if match = method.to_s.match(/^(.*)=$/)
+          super
+        elsif has_flock?(method)
+          @flocks[method]
+        else
+          nil
+        end
+      end
+
+      def has_flock?(name)
+        @flocks.keys.include? name
+      end
+    end
+
+  end
+end

data/lib/mocking_bird/version.rb

@@ -0,0 +1,3 @@
+module MockingBird
+  VERSION = "0.0.2"
+end

data/mocking_bird.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mocking_bird/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mocking_bird"
+  spec.version       = MockingBird::VERSION
+  spec.authors       = ["Brandon Sislow"]
+  spec.email         = ["bsislow@avvo.com"]
+  spec.summary       = %q{Mock manager for cross services mocks}
+  spec.description   = %q{A mock manager to load mocks based on convention, similar to fixtures, while being fetchable}
+  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 "json_api_client_mock"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: mocking_bird
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Brandon Sislow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_api_client_mock
+  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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: A mock manager to load mocks based on convention, similar to fixtures,
+  while being fetchable
+email:
+- bsislow@avvo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- atlassian-ide-plugin.xml
+- lib/mocking_bird.rb
+- lib/mocking_bird/bird.rb
+- lib/mocking_bird/flock.rb
+- lib/mocking_bird/mock.rb
+- lib/mocking_bird/mocker.rb
+- lib/mocking_bird/version.rb
+- mocking_bird.gemspec
+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: Mock manager for cross services mocks
+test_files: []