spitter 0.0.1

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+*.gem
+dist
+.yardopts
+.yardoc
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+script: bundle exec rspec spec

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    spitter (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  rspec (~> 2.6)
+  spitter!

data/README.rdoc

@@ -0,0 +1,83 @@
+= Spitter {<img src="https://secure.travis-ci.org/bonsaiben/spitter.png">}[http://travis-ci.org/bonsaiben/spitter] {<img src="https://gemnasium.com/bonsaiben/spitter.png">}[https://gemnasium.com/bonsaiben/spitter]
+
+Takes nice Ruby parameter hashes and spits out whatever crap you need it to. A simple way to provide a custom Ruby interface for the request side of an API wrapper. Based on @mislav's nibbler[https://github.com/mislav/nibbler].
+
+
+== Installation
+
+  gem install spitter
+
+
+== Example Usage
+
+=== Transform Key
+
+  class ApiClient < Spitter
+    parameter :ruby_param => 'apiCamelCaseDataFlag'
+  end
+
+  $ ApiClient.parse(:purchasable => '1')
+  => {'apiCamelCaseDataFlag' => '1'}
+
+=== Transform Value with Lambda
+
+  class ApiClient < Spitter
+    parameter :ruby_param => 'apiCamelCaseDataFlag', :with => lambda {|v| v ? '1' : '0'}
+  end
+
+  $ ApiClient.parse(:purchasable => true)
+  => {'apiCamelCaseDataFlag' => '1'}
+
+=== Transform Value with Class
+
+  class ApiClient < Spitter
+    class TrueOrFalse
+      def self.parse(val)
+        val ? '1' : '0'
+      end
+    end
+
+    parameter :ruby_param => 'apiCamelCaseDataFlag', :with => TrueOrFalse
+  end
+
+  $ ApiClient.parse(:purchasable => true)
+  => {'apiCamelCaseDataFlag' => '1'}
+
+=== Transform Value Only
+
+  class ApiClient < Spitter
+    parameter :timestamp, :with => lambda{|v| v.to_i.to_s }
+  end
+
+  $ ApiClient.parse(:timestamp => Time.now)
+  => {'timestamp' => '1341162393'}
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2012 Benjamin Sullivan
+
+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.
+
+
+== Credit
+
+Spitter is based on @mislav's nibbler[https://github.com/mislav/nibbler].

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/spitter/version.rb

@@ -0,0 +1,3 @@
+class Spitter
+  VERSION = "0.0.1"
+end

data/lib/spitter.rb

@@ -0,0 +1,101 @@
+module SpitterMethods
+  def self.extended(base)
+    base.send(:include, InstanceMethods) if base.is_a? Class
+  end
+
+  # Declare a singular spitting rule
+  def parameter(*args, &block)
+    key, name, delegate = parse_rule_declaration(*args, &block)
+    rules[key] = [name, delegate]
+    key
+  end
+
+  # Declare a plural spitting rule
+  def parameters(*args, &block)
+    key = parameter(*args, &block)
+    rules[key] << true
+  end
+
+  # Parsing rules declared with `parameter` or `parameters`
+  def rules
+    @rules ||= {}
+  end
+
+  # Process data by creating a new instance
+  def parse(params) new(params).parse end
+
+  private
+
+  # Make subclasses inherit the parsing rules
+  def inherited(subclass)
+    super
+    subclass.rules.update self.rules
+  end
+
+  # Rule declaration forms:
+  #
+  #   { :key => 'property', :with => delegate }
+  #     #=> [:key, 'property', delegate]
+  #
+  #   :title
+  #     #=> [:title, 'title', nil]
+  def parse_rule_declaration(*args, &block)
+    options, name = Hash === args.last ? args.pop : {}, args.first
+    delegate = options.delete(:with)
+    key, property = name ? [name.to_sym, name.to_s] : options.to_a.flatten
+    property = property[key.to_s] if property.is_a?(Proc)
+    property = property.method(property.respond_to?(:call) ? :call : :parse)[key.to_s] if property.is_a?(Class)
+    raise ArgumentError, "invalid rule declaration: #{args.inspect}" unless property
+    # eval block in context of a new spitter subclass
+    delegate = Class.new(Spitter, &block) if block_given?
+    return key, property, delegate
+  end
+
+  def base_parser_class
+    klass = self
+    klass = klass.superclass until klass.superclass == Object
+    klass
+  end
+
+  module InstanceMethods
+
+    # Initialize the parser with parameters
+    def initialize(params)
+      @params = params
+    end
+
+    def params
+      @params ||= {}
+    end
+
+    def parse
+      request_params = {}
+      self.class.rules.each do |target, (key, delegate, plural)|
+        if @params.has_key?(target)
+          if plural
+            request_params.merge!(delegate.parse(@params[target]))
+          else
+            request_params[key] = parse_result(@params[target], delegate)
+          end
+        end
+      end
+      request_params
+    end
+
+    protected
+
+    # `delegate` is optional, but should respond to `call` or `parse`
+    def parse_result(node, delegate)
+      if delegate
+        method = delegate.is_a?(Proc) ? delegate : delegate.method(delegate.respond_to?(:call) ? :call : :parse)
+        method.arity == 1 ? method[node] : (method.arity == 2 ? method[node, self] : method[])
+      else
+        node
+      end
+    end
+  end
+end
+
+class Spitter
+  extend SpitterMethods
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'spitter'
+

data/spec/spitter_spec.rb

@@ -0,0 +1,121 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe Spitter do
+
+  context "no conversion" do
+    before do
+      @params = {:code => "1234"}
+      @spitter = Class.new(Spitter){ parameter :code }.new(@params)
+    end
+
+    it "creates the rules" do
+      @spitter.class.rules.should eq({:code => ['code',nil]})
+    end
+
+    it "transforms the params" do
+      new_params = @spitter.parse
+      new_params.should eq({'code' => '1234'})
+    end
+  end
+
+  context "simple conversion" do
+    before do
+      @params = {:item_id => 1}
+      @spitter = Class.new(Spitter){ parameter :item_id => 'itemId' }.new(@params)
+    end
+
+    it "creates the rules" do
+      @spitter.class.rules.should eq({:item_id => ['itemId',nil]})
+    end
+
+    it "transforms the params" do
+      new_params = @spitter.parse
+      new_params.should eq({'itemId' => 1})
+    end
+  end
+
+  context "proc conversion" do
+    before do
+      @params = {:item_id => 1}
+      @spitter = Class.new(Spitter){ parameter :item_id => lambda {|i| i.to_s.upcase }}.new(@params)
+    end
+
+    it "creates the rules" do
+      @spitter.class.rules.should eq({:item_id => ['ITEM_ID',nil]})
+    end
+
+    it "transforms the params" do
+      new_params = @spitter.parse
+      new_params.should eq({'ITEM_ID' => 1})
+    end
+  end
+
+  context "class conversion" do
+    before do
+      @params = {:item_id => 1}
+      klass = Class.new do
+        def self.parse val
+          val.upcase
+        end
+      end
+      @spitter = Class.new(Spitter){ parameter :item_id => klass }.new(@params)
+    end
+
+    it "creates the rules" do
+      @spitter.class.rules.should eq({:item_id => ['ITEM_ID',nil]})
+    end
+
+    it "transforms the params" do
+      new_params = @spitter.parse
+      new_params.should eq({'ITEM_ID' => 1})
+    end
+  end
+
+  context "value conversion with proc" do
+    before do
+      @params = {:is_cool => true}
+      @spitter = Class.new(Spitter){ parameter :is_cool => 'isCool', :with => lambda { |a| a ? "1" : "0" } }.new(@params)
+    end
+
+    it "transforms the params" do
+      new_params = @spitter.parse
+      new_params.should eq({'isCool' => '1'})
+    end
+  end
+
+  context "value conversion with class" do
+    before do
+      @params = {:is_cool => true}
+      klass = Class.new do
+        def self.parse val
+          val ? "1" : "0"
+        end
+      end
+      @spitter = Class.new(Spitter){ parameter :is_cool => 'isCool', :with => klass }.new(@params)
+    end
+
+    it "transforms the params" do
+      new_params = @spitter.parse
+      new_params.should eq({'isCool' => '1'})
+    end
+  end
+
+  context "nested conversion" do
+    before do
+      @params = {:shop => {:name => "roomba", :code => "123"} }
+      @spitter = Class.new(Spitter) do
+        parameters :shop do
+          parameter :name => 'shopName'
+          parameter :code => 'shopCode'
+        end
+      end.new(@params)
+    end
+
+    it "transforms the params" do
+      new_params = @spitter.parse
+      new_params.should eq({'shopName' => 'roomba', 'shopCode' => '123'})
+    end
+  end
+
+end

data/spitter.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path('../lib/spitter/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = %q{spitter}
+  s.version = Spitter::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = ">= 1.3.6"
+  s.authors = ["Benjamin Sullivan"]
+  s.email = %q{bsullivan2@gmail.com}
+  s.homepage = %q{http://github.com/bonsaiben/spitter}
+  s.summary = %q{A simple way to provide a custom Ruby interface for the request side of an API wrapper.}
+  s.description = %q{Takes nice Ruby parameter hashes and spits out whatever crap you need it to.}
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", "~> 2.6"
+
+  s.files = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+
+end
+

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: spitter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Sullivan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-01 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.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Takes nice Ruby parameter hashes and spits out whatever crap you need
+  it to.
+email: bsullivan2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/spitter.rb
+- lib/spitter/version.rb
+- spec/spec_helper.rb
+- spec/spitter_spec.rb
+- spitter.gemspec
+homepage: http://github.com/bonsaiben/spitter
+licenses: []
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple way to provide a custom Ruby interface for the request side of an
+  API wrapper.
+test_files: []
+has_rdoc: