active_service_mapper 0.0.1

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bhaskar Sundarraj
+
+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,49 @@
+# ActiveServiceMapper
+
+This gem will convert the json responses received from the web services to ruby hash.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_service_mapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_service_mapper
+
+## Usage
+      #service response in jso format 
+      
+      1. response = {"FirstName"=>"Bob", "LastName"=>"Newhart"}
+      
+      # convert the json response to a hash with symbols.
+      
+      2. response = Person.convert_response(response)
+
+      3. puts response #{:first_name=>"Bob", :last_name=>"Newhart"}
+   
+        
+     4. we can use plain_old_model gem and the person calss can be 
+    
+    class Person < PlainOldModel::Base
+      attr_accessor :first_name, :last_name
+    end
+
+     5. @person = Person.new(response)
+     
+## TODO
+    # add complex mapping, i.e when the service response keys are different from the class attribute names.
+    # 
+
+## 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,8 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/active_service_mapper.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_service_mapper/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "active_service_mapper"
+  gem.version       = ActiveServiceMapper::VERSION
+  gem.authors       = ["Bhaskar Sundarraj"]
+  gem.email         = ["bhaskar.sundarraj@gmail.com"]
+  gem.description   = %q{This gem will provide a mapping functionality (like automapping service layer to the model) for projects which deal with services- preferably json responses.}
+  gem.summary       = %q{This gem will provide a mapping functionality (like automapping service layer to the model) for projects which deal with services- preferably json responses.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency 'plain_old_model'
+  gem.add_dependency 'activesupport'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-core'
+end

data/example/billing_address.rb

@@ -0,0 +1,7 @@
+require 'plain_old_model'
+require_relative 'phone_number'
+class BillingAddress < PlainOldModel::Base
+  attr_accessor :address1, :address2
+  has_one :phone_number
+
+end

data/example/person.rb

@@ -0,0 +1,13 @@
+require 'active_service_mapper'
+require 'plain_old_model/base'
+require_relative 'billing_address'
+
+class Person < PlainOldModel::Base
+  attr_accessor :first_name, :last_name
+  has_one :billing_address
+
+  extend ActiveServiceMapper
+  def self.convert_response(response,options={})
+    convert_to_symbol(response,options={})
+  end
+end

data/example/phone_number.rb

@@ -0,0 +1,4 @@
+require 'plain_old_model/base'
+class PhoneNumber < PlainOldModel::Base
+  attr_accessor :phone, :ext
+end

data/lib/active_service_mapper.rb

@@ -0,0 +1,54 @@
+require "active_service_mapper/version"
+require 'plain_old_model/base'
+module ActiveServiceMapper
+  extend self
+  def convert_to_symbol(response,options={})
+     keys_to_symbol(response, options={})
+  end
+
+
+  def keys_to_symbol(response, options)
+    new_hash = {}
+    response.each do |key,value|
+      if value.class == Hash
+        new_hash[key_to_symbol(key,options={})] = keys_to_symbol(value,options)
+      elsif value.class == Array
+        new_hash[key_to_symbol(key,options={})] = keys_to_symbol_array(value)
+      else #if value.class == String || value.class == Fixnum || value.class == Float
+        new_hash[key_to_symbol(key,options={})] = value
+      end
+    end
+    return new_hash
+  end
+
+  def key_to_symbol(key,options={})
+    key.to_s.underscore.to_sym
+  end
+
+  def keys_to_symbol_array(array)
+    new_array = []
+    array.each do |item|
+      if item.class == Hash
+        new_array << keys_to_symbol(item,options={})
+      elsif item.class == Array
+        new_array << keys_to_symbol_array(item)
+      else
+        new_array << item
+      end
+    end
+    return new_array
+  end
+
+
+end
+
+
+# simple case - just convert the response keys to rails format.
+
+# somewhat complex
+# - The hash has nested hash and arrays.
+# -  Do the same as simple case.
+
+# complex : When the service response keys don't match up with the model's attributes.
+ # 3rd case option 1: A dsl implementation at the class level , which does indicate the mapping level
+ # 3rd case option 2 : A Config file which tells the mapper that certain fields from certain class map to certain field in the response.

data/lib/active_service_mapper/base.rb

@@ -0,0 +1,6 @@
+module ActiveServiceMapper
+  class Base
+
+  end
+
+end

data/lib/active_service_mapper/version.rb

@@ -0,0 +1,3 @@
+module ActiveServiceMapper
+  VERSION = "0.0.1"
+end

data/spec/lib/base_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+#require 'json'
+
+
+describe ActiveServiceMapper::Base do
+extend ActiveServiceMapper
+  #describe "Version" do
+  #it "should return the correct version" do
+  #  ActiveServiceMapper::VERSION.should == '0.0.1'
+  #end
+  #end
+
+  describe "Parsing json responses to rails hash format " do
+    it"should convert simple response values  to a hash" do
+      simple_response = {"FirstName"=>"Bob", "LastName"=>"Newhart"}
+      Person.convert_response(simple_response).should == {:first_name=>"Bob", :last_name=>"Newhart"}
+    end
+
+    it"should convert response's with nested array values to a hash" do
+      not_simple_response = {"TestMe" => [{"Id"=> "one", "Desc" =>"Test"},{"Id"=> "two", "Desc" =>"test2"}]}
+      Person.convert_response(not_simple_response).should == {:test_me => [{:id => "one", :desc =>"Test"},{:id => "two", :desc =>"test2"}]}
+    end
+
+    it"should convert responses with nested hash values to a hash format" do
+      response_with_nested_attributes = {"FirstName"=>"Bob", "LastName"=>"Newhart", "BillingAddress" => {"Address1" => "one", "Address2" => "Two"}}
+      Person.convert_response(response_with_nested_attributes).should == {:first_name=>"Bob", :last_name=>"Newhart", :billing_address => {:address1 => "one", :address2 => "Two"}}
+    end
+    it"should convert responses with  one level deep nested values to the proper hash format" do
+      response_with_nested_attributes = {"FirstName"=>"Bob", "LastName"=>"Newhart", "BillingAddress" => {"Address1" => "one", "Address2" => "Two", "PhoneNumber" => {"Phone" => "123456789","Ext" => "2313"}}}
+      Person.convert_response(response_with_nested_attributes).should == {:first_name=>"Bob", :last_name=>"Newhart", :billing_address=>{:address1=>"one", :address2=>"Two",:phone_number=>{:phone=>"123456789", :ext=>"2313"}} }
+    end
+    it"should convert responses with multi level nested values to hash format" do
+      response_with_nested_attributes = {"FirstName"=>"Bob", "LastName"=>"Newhart", "BillingAddress" => {"Address1" => "one", "Address2" => "Two", "PhoneNumber" => {"Phone" => "123456789","Ext" => "2313", "TestMe" => [{"Id"=> "one", "Desc" =>"test"},{"Id"=> "two", "Desc" =>"test2"} ]}}}
+      Person.convert_response(response_with_nested_attributes).should == {:first_name=>"Bob", :last_name=>"Newhart",:billing_address=>{:address1=>"one", :address2=>"Two",:phone_number => {:phone => "123456789",:ext => "2313", :test_me => [{:id => "one", :desc =>"test"},{:id => "two", :desc =>"test2"} ]}}}
+    end
+    it"should assign the responses with deep nested hashes and arrays to proper hash" do
+      response_with_nested_attributes = {"FirstName"=>"Bob", "LastName"=>"Newhart", "BillingAddress" => {"Address1" => "one", "Address2" => "Two", "PhoneNumber" => {"Phone" => "123456789","Ext" => "2313", "TestMe" => [{"Id"=> "one", "Desc" =>"test", "Test" => [{"ID" => "identity"}]},{"Id"=> "two", "Desc" =>"test2"} ]}}}
+      Person.convert_response(response_with_nested_attributes).should == {:first_name=>"Bob", :last_name=>"Newhart", :billing_address=>{:address1=>"one", :address2=>"Two", :phone_number=>{:phone=>"123456789", :ext=>"2313", :test_me=>[{:id=>"one", :desc=>"test", :test=>[{:id=>"identity"}]}, {:id=>"two", :desc=>"test2"}]}}}
+    end
+
+  end
+
+  describe "response mapping to class" do
+    it"should assign the simple response values  to a hash" do
+      simple_response = {"FirstName"=>"Bob", "LastName"=>"Newhart"}
+      Person.convert_response(simple_response).should == {:first_name=>"Bob", :last_name=>"Newhart"}
+      @person = Person.new(Person.convert_to_symbol(simple_response))
+      @person.first_name.should == "Bob"
+      @person.last_name.should == "Newhart"
+    end
+    it"should assign the response's nested array values  to a hash" do
+      not_simple_response = {"TestMe" => [{"Id"=> "one", "Desc" =>"Test"},{"Id"=> "two", "Desc" =>"test2"}]}
+      response = Person.convert_response(not_simple_response)
+      response.should == {:test_me => [{:id => "one", :desc =>"Test"},{:id => "two", :desc =>"test2"}]}
+      @person = Person.new(response)
+    end
+    it"should assign the responses with nested hash values to a hash" do
+      response_with_nested_attributes = {"FirstName"=>"Bob", "LastName"=>"Newhart", "BillingAddress" => {"Address1" => "one", "Address2" => "Two"}}
+      response = Person.convert_response(response_with_nested_attributes)
+      response.should == {:first_name=>"Bob", :last_name=>"Newhart", :billing_address => {:address1 => "one", :address2 => "Two"}}
+      #@person = Person.new(response)
+      #@person.billing_address.should == {:address1 => "one", :address2 => "Two"}
+      #puts @person.billing_address.class
+
+    end
+    it"should assign the responses with multi level nested values to the class attribute" do
+      response_with_nested_attributes = {"FirstName"=>"Bob", "LastName"=>"Newhart", "BillingAddress" => {"Address1" => "one", "Address2" => "Two", "PhoneNumber" => {"Phone" => "123456789","Ext" => "2313", "TestMe" => [{"Id"=> "one", "Desc" =>"test"},{"Id"=> "two", "Desc" =>"test2"} ]}}}
+      response = Person.convert_response(response_with_nested_attributes)
+      response.should == {:first_name=>"Bob", :last_name=>"Newhart",:billing_address=>{:address1=>"one", :address2=>"Two",:phone_number => {:phone => "123456789",:ext => "2313", :test_me => [{:id => "one", :desc =>"test"},{:id => "two", :desc =>"test2"} ]}}}
+      #@person = Person.new(response)
+      #@person.billing_address.should == {:address1=>"one", :address2=>"Two", :phone_number=>{:phone=>"123456789", :ext=>"2313", :test_me=>[{:id=>"one", :desc=>"test"}, {:id=>"two", :desc=>"test2"}]}}
+      #@billing_address = @person.billing_address
+      ##@phone = @billing_address.phone_number
+    end
+    it"should assign the responses with multi level nested values to the class attribute" do
+      response_with_nested_attributes = {"FirstName"=>"Bob", "LastName"=>"Newhart", "BillingAddress" => {"Address1" => "one", "Address2" => "Two", "PhoneNumber" => {"Phone" => "123456789","Ext" => "2313", "TestMe" => [{"Id"=> "one", "Desc" =>"test", "Test" => [{"ID" => "identity"}]},{"Id"=> "two", "Desc" =>"test2"} ]}}}
+      Person.convert_response(response_with_nested_attributes).should == {:first_name=>"Bob", :last_name=>"Newhart", :billing_address=>{:address1=>"one", :address2=>"Two", :phone_number=>{:phone=>"123456789", :ext=>"2313", :test_me=>[{:id=>"one", :desc=>"test", :test=>[{:id=>"identity"}]}, {:id=>"two", :desc=>"test2"}]}}}
+    end
+
+  end
+
+end
+
+
+
+# mapper , a config file which tells what to map to where . i.e like class.attribute = service.attribute
+#
+#
+
+require 'plain_old_model/base'
+require 'active_service_mapper'
+class Person < PlainOldModel::Base
+  require_relative '../../example/billing_address'
+  attr_accessor :first_name, :last_name
+  has_one :billing_address
+
+  extend ActiveServiceMapper
+  def self.convert_response(response,options={})
+    convert_to_symbol(response,options={})
+  end
+end
+
+class BillingAddress < PlainOldModel::Base
+  attr_accessor :address1, :address2
+  has_one :phone_number
+
+end
+
+class PhoneNumber < PlainOldModel::Base
+  attr_accessor :phone, :ext
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'active_service_mapper'
+require 'active_service_mapper/version'
+require 'active_service_mapper/base'
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: active_service_mapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bhaskar Sundarraj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plain_old_model
+  requirement: &70147494836600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70147494836600
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70147494835860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70147494835860
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70147494835200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70147494835200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70147494846700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70147494846700
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: &70147494845220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70147494845220
+description: This gem will provide a mapping functionality (like automapping service
+  layer to the model) for projects which deal with services- preferably json responses.
+email:
+- bhaskar.sundarraj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_service_mapper.gemspec
+- example/billing_address.rb
+- example/person.rb
+- example/phone_number.rb
+- lib/active_service_mapper.rb
+- lib/active_service_mapper/base.rb
+- lib/active_service_mapper/version.rb
+- spec/lib/base_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: This gem will provide a mapping functionality (like automapping service layer
+  to the model) for projects which deal with services- preferably json responses.
+test_files:
+- spec/lib/base_spec.rb
+- spec/spec_helper.rb