fetching 0.4.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+quickfix.out

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Gee
+
+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,31 @@
+# Fetching
+
+Turn deeply nested hashes and arrays (like an API response) into an whiney object with method syntax.
+
+## Usage
+
+```ruby
+Fetching(HTTParty.get(url, query: query)).forms[0].request_form_id
+
+# fails loudly unless the response from HTTParty has a top level `forms` key
+# fails loudly if `forms` is an empty array
+# fails loudly if the first `form` doesn't have a `request_form_id` key
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fetching', git: 'https://github.com/covermymeds/fetching-gem.git'
+
+And then execute:
+
+    $ bundle
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/fetching.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fetching/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fetching"
+  spec.version       = Fetching::VERSION
+  spec.authors       = ["Michael Gee", "Mark Lorenz"]
+  spec.email         = ["mgee@covermymeds.com", "mlorenz@covermymeds.com"]
+  spec.description   = %q{More sass in more structs.}
+
+  spec.summary       = <<-HEREDOC
+This gem is a work in progress.  The implementation code is not what's
+important.  What is important: Don't de-serialize API responses in to
+hashes and arrays.  Use a "strict" object that inforces key presence,
+and array bounds.}
+HEREDOC
+
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry-plus"
+end

data/lib/fetching/version.rb

@@ -0,0 +1,3 @@
+class Fetching
+  VERSION = "0.4.1"
+end

data/lib/fetching.rb

@@ -0,0 +1,94 @@
+require "json"
+
+module Kernel
+
+  def Fetching(arg)
+    Fetching.from(arg)
+  end
+
+end
+
+class Fetching
+
+  WHITELIST = %w[ define_singleton_method class object_id
+                  == inspect to_s instance_variables instance_eval
+                  instance_variable_get ]
+  all_methods = instance_methods.map(&:to_s).grep(/\A[^_]/)
+  (all_methods - WHITELIST).each(&method(:undef_method))
+
+  def self.from(value)
+    case value
+    when ->(v) { v.respond_to? :to_ary }
+      FetchingArray.new(value.to_ary)
+    when ->(v) { v.respond_to? :to_hash }
+      FetchingHash.new(value.to_hash)
+    else
+      value
+    end
+  end
+
+  def self.from_json json, closure
+    from(JSON.parse json).__send__ closure
+  end
+
+  def initialize table
+    @table = table
+  end
+
+  def ==(other)
+    other.hash == hash
+  end
+
+  def hash
+    self.class.hash ^ @table.hash
+  end
+
+  private
+
+  def no_method key
+  end
+
+end
+
+class FetchingArray < Fetching
+
+  include Enumerable
+
+  def [](index)
+    Fetching.from @table.fetch(index)
+  end
+
+  def each
+    @table.each_index do |i|
+      yield self[i]
+    end
+  end
+
+end
+
+class FetchingHash < Fetching
+
+  def initialize *args
+    super
+    make_methods
+  end
+
+  def to_hash
+    @table.dup
+  end
+
+  private
+
+  def make_methods
+    @table.each do |k, v|
+      define_singleton_method(k) do
+        Fetching.from(v)
+      end
+    end
+  end
+
+  def method_missing key, *args, &block
+    fail NoMethodError, "#{key} not found\nyou have:\n#{@table.inspect}"
+  end
+
+end

data/spec/fetching_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+describe Fetching do
+
+  let(:input)       { { one: 1, two: two, ary: ary, object_ary: object_ary } }
+  let(:two)         { { "two"=>2 } }
+  let(:ary)         { [1, 2] }
+  let(:object_ary)  { [{}, last_object] }
+  let(:last_object) { { three: 3 } }
+
+  subject { Fetching(input) }
+  specify("#one") { expect(subject.one).to eq(1) }
+  specify("#two") { expect(subject.two).to eq(Fetching(two)) }
+  specify("#ary") { expect(subject.ary).to eq(Fetching(ary)) }
+  specify "objects in arrays" do
+    expect(subject.object_ary[1].three).to eq(3)
+  end
+
+  describe "an unknown hash key" do
+    it "raises NoMethodError" do
+      expected_message = "not_a_key not found\nyou have:\n{:one=>1, :two=>{\"two\"=>2}, :ary=>[1, 2], :object_ary=>[{}, {:three=>3}]}"
+
+      expect{ subject.not_a_key }.to raise_error(NoMethodError, expected_message)
+    end
+  end
+
+  describe "an unknown array index" do
+    it "raises NoMethodError" do
+      expected_message = "index 3 outside of array bounds: -2...2"
+      expect{ subject.ary[ary.size + 1] }.to raise_error(IndexError, expected_message)
+    end
+  end
+
+  describe "a bad closure" do
+    it "raises the expected error" do
+      expect { Fetching.from_json("{}", :not_a_key) }.to raise_error(NoMethodError)
+    end
+  end
+
+end
+
+describe FetchingHash do
+
+  specify "#to_hash" do
+    hash = {one: 1, two: 2}
+    sassy_hash = Fetching(hash)
+    expect(sassy_hash.to_hash).to eq(hash)
+  end
+
+  specify "#to_hash doesn't allow you to break fetching" do
+    sassy_hash = Fetching(one: 1, two: 2)
+    hash = sassy_hash.to_hash
+    hash[:one] = ":)"
+    expect(sassy_hash.to_hash[:one]).to eq(1)
+  end
+
+  specify "#to_hash does a deep copy" do
+    hash = {one: 1, two: {three: 3}}
+    sassy_hash = Fetching(hash)
+    expect(sassy_hash.to_hash).to eq(hash)
+  end
+
+end
+
+describe FetchingArray do
+
+  specify "#map" do
+    ary = [1, 2]
+    sassy_ary = Fetching(ary)
+    expect(sassy_ary.map(&:to_s)).to eq(%w[1 2])
+  end
+
+  specify "Sassiness should go deep" do
+    Fetching([{one: 1}]).each do |element|
+      expect(element.one).to eq(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "fetching"
+require "rspec/autorun"
+require "pathname"
+
+Pathname(__FILE__).dirname.join("support").each_child { |f| require f }
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

data/spec/support/vim_formatter.rb

@@ -0,0 +1,35 @@
+# Adapted from https://github.com/bronson/vim-runtest/blob/master/rspec_formatter.rb.
+require 'rspec/core/formatters/base_text_formatter'
+
+class VimFormatter < RSpec::Core::Formatters::BaseTextFormatter
+
+  def example_failed example
+    exception = example.execution_result[:exception]
+    path = Regexp.last_match[1] if exception.backtrace.find do |frame|
+      frame =~ %r{\b(spec/.*_spec\.rb:\d+)(?::|\z)}
+    end
+    message = format_message exception.message
+    path    = format_caller(path || ' ')
+    output.puts "#{path}: #{example.example_group.description.strip} " +
+      "#{example.description.strip}: #{message.strip}" if path
+  end
+
+  def example_pending *args; end
+
+  def dump_failures   *args; end
+
+  def dump_pending    *args; end
+
+  def message          msg;  end
+
+  def dump_summary    *args; end
+
+  def seed            *args; end
+
+  private
+
+  def format_message msg
+    msg.gsub("\n", ' ')[0, 80]
+  end
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: fetching
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Gee
+- Mark Lorenz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-plus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: More sass in more structs.
+email:
+- mgee@covermymeds.com
+- mlorenz@covermymeds.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fetching.gemspec
+- lib/fetching.rb
+- lib/fetching/version.rb
+- spec/fetching_spec.rb
+- spec/spec_helper.rb
+- spec/support/vim_formatter.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ! 'This gem is a work in progress.  The implementation code is not what''s
+  important.  What is important: Don''t de-serialize API responses in to hashes and
+  arrays.  Use a "strict" object that inforces key presence, and array bounds.}'
+test_files:
+- spec/fetching_spec.rb
+- spec/spec_helper.rb
+- spec/support/vim_formatter.rb
+has_rdoc: