transcriber 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Rakefile

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

data/lib/transcriber/resource/embeddables/embeddable.rb

@@ -0,0 +1,31 @@
+class Transcriber::Resource
+  class Embeddable
+    autoload :Parser,   'transcriber/resource/embeddables/parser'
+    autoload :Resource, 'transcriber/resource/embeddables/resource'
+    include   Parser
+    include   Resource
+
+    attr_accessor :name
+    attr_accessor :class_name
+    attr_accessor :start_key
+    attr_accessor :many
+    attr_accessor :options
+
+    def initialize(name, options = {})
+      @name = name
+
+      @class_name = (options.delete(:class_name) || name).to_s.camelize
+      @start_key  =  options.delete(:start_key)
+      @many       =  options.delete(:many)
+      @options    =  options
+    end
+
+    def one?
+      !@many
+    end
+
+    def many?
+      @many
+    end
+  end
+end

data/lib/transcriber/resource/embeddables/parser.rb

@@ -0,0 +1,10 @@
+class Transcriber::Resource::Embeddable
+  module Parser
+    def parse(item)
+      options = {}
+      options.merge!(start_key: start_key) if start_key
+      value = class_name.constantize.parse(item, options)
+      one? ? value.first : value
+    end
+  end
+end

data/lib/transcriber/resource/embeddables/resource.rb

@@ -0,0 +1,9 @@
+class Transcriber::Resource::Embeddable
+  module Resource
+    def to_resource(resource)
+      resource = resource.__send__(name)
+      resource = resource.map(&:resource) if resource.kind_of?(Enumerable)
+      {name => resource}
+    end
+  end
+end

data/lib/transcriber/resource/embeddables.rb

@@ -0,0 +1,18 @@
+class Transcriber::Resource
+  module Embeddables
+    def embeds(name, options)
+      attr_accessor name
+      keys << Embeddable.new(name, options)
+    end
+
+    def embeds_one(name, options = {})
+      options.merge!(many: false)
+      embeds(name, options)
+    end
+
+    def embeds_many(name, options = {})
+      options.merge!(many: true)
+      embeds(name, options)
+    end
+  end
+end

data/lib/transcriber/resource/parser.rb

@@ -0,0 +1,26 @@
+class Transcriber::Resource
+  module Parser
+    def parse(input, options = {})
+      entries(input, options).collect {|item| parse_one(item)}
+    end
+
+    private
+
+    def entries(input, options)
+      start_key = options[:start_key]
+      entries = input
+      if entries.kind_of?(Hash)
+        entries = entries[start_key.to_s.upcase] if start_key
+        entries = [entries]
+      end
+      entries
+    end
+
+    def parse_one(item)
+      params = keys.inject({}) do |buffer, key|
+        buffer.merge key.name => key.parse(item)
+      end
+      self.new(params)
+    end
+  end
+end

data/lib/transcriber/resource/properties/parser.rb

@@ -0,0 +1,9 @@
+class Transcriber::Resource::Property
+  module Parser
+    def parse(item, options = {})
+      value = serializer.serialize(item[field])
+      value = values.key(value) if values
+      value
+    end
+  end
+end

data/lib/transcriber/resource/properties/property.rb

@@ -0,0 +1,30 @@
+class Transcriber::Resource
+  class Property
+    autoload :Parser,   'transcriber/resource/properties/parser'
+    autoload :Resource, 'transcriber/resource/properties/resource'
+    include   Parser
+    include   Resource
+
+    attr_accessor :name
+    attr_accessor :field
+    attr_accessor :serializer
+    attr_accessor :values
+    attr_accessor :options
+
+    def initialize(name, options = {})
+      @name  = name
+      @field = prepare_field(options.delete(:field) || name)
+      @serializer = (options.delete(:type)  || Serialization::String)
+      @values     =  options.delete(:values)
+      @options    =  options
+    end
+
+    def prepare_field(field)
+      field.to_s.upcase # @TODO this logic shouldn't be here.
+                        # it's a key conversion strategy
+                        # convert(field).to_s, convert should be
+                        # an identity function if a custom
+                        # strategy was not set.
+    end
+  end
+end

data/lib/transcriber/resource/properties/resource.rb

@@ -0,0 +1,7 @@
+class Transcriber::Resource::Property
+  module Resource
+    def to_resource(resource)
+      {name => resource.__send__(name)}
+    end
+  end
+end

data/lib/transcriber/resource/properties.rb

@@ -0,0 +1,8 @@
+class Transcriber::Resource
+  module Properties
+    def property(name, options = {})
+      attr_accessor name
+      keys << Property.new(name, options)
+    end
+  end
+end

data/lib/transcriber/resource/responses.rb

@@ -0,0 +1,13 @@
+module Transcriber
+  class Resource
+    module Responses
+      def respond_with(model, options = {})
+        response = model.kind_of?(Array) ?
+                     model.first.class.resources(model)
+                   : model.resource
+
+        [200, {"Content-Type" => "application/json"}, response.to_json]
+      end
+    end
+  end
+end

data/lib/transcriber/resource/serialization/boolean.rb

@@ -0,0 +1,14 @@
+class Transcriber::Resource
+  module Serialization
+    class Boolean
+      MAPPINGS = {true  => [true,  "true",  "TRUE",  "1", 1, 1.0, "x", "X", "t", "T"],
+                  false => [false, "false", "FALSE", "0", 0, 0.0,  "", " ", "f", "F", nil]}
+
+      def self.serialize(value)
+        return true  if MAPPINGS[true].include?(value)
+        return false if MAPPINGS[false].include?(value)
+        raise "value not serializable: #{{value: value, mappings: MAPPINGS}}"
+      end
+    end
+  end
+end

data/lib/transcriber/resource/serialization/date.rb

@@ -0,0 +1,13 @@
+class Transcriber::Resource
+  module Serialization
+    class Date
+      def self.serialize(value)
+        begin
+          ::Date.parse value
+        rescue
+          raise "value not serializable: #{{value: value}}"
+        end
+      end
+    end
+  end
+end

data/lib/transcriber/resource/serialization/float.rb

@@ -0,0 +1,9 @@
+class Transcriber::Resource
+  module Serialization
+    class Float
+      def self.serialize(value)
+        value.to_f
+      end
+    end
+  end
+end

data/lib/transcriber/resource/serialization/string.rb

@@ -0,0 +1,9 @@
+class Transcriber::Resource
+  module Serialization
+    class String
+      def self.serialize(value)
+        "#{value}"
+      end
+    end
+  end
+end

data/lib/transcriber/resource/serialization.rb

@@ -0,0 +1,10 @@
+module Transcriber
+  class Resource
+    module Serialization
+      autoload :Boolean, 'transcriber/resource/serialization/boolean'
+      autoload :Date,    'transcriber/resource/serialization/date'
+      autoload :Float,   'transcriber/resource/serialization/float'
+      autoload :String,  'transcriber/resource/serialization/string'
+    end
+  end
+end

data/lib/transcriber/resource.rb

@@ -0,0 +1,32 @@
+module Transcriber
+  class Resource
+    autoload :Serialization, 'transcriber/resource/serialization'
+    autoload :Properties,    'transcriber/resource/properties'
+    autoload :Property,      'transcriber/resource/properties/property'
+    autoload :Embeddables,   'transcriber/resource/embeddables'
+    autoload :Embeddable,    'transcriber/resource/embeddables/embeddable'
+    autoload :Parser,        'transcriber/resource/parser'
+    autoload :Responses,     'transcriber/resource/responses'
+
+    extend  Properties
+    extend  Embeddables
+    extend  Parser
+    include Serialization
+
+    def initialize(attrs = {})
+      attrs.map {|name, value| send("#{name}=", value)}
+    end
+
+    def self.keys
+      @keys ||= []
+    end
+
+    def self.resources(entries)
+      {entries: entries.map(&:resource)}
+    end
+
+    def resource
+      self.class.keys.inject({}) {|buffer, key| buffer.merge key.to_resource(self)}
+    end
+  end
+end

data/lib/transcriber/version.rb

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

data/lib/transcriber.rb

@@ -0,0 +1,6 @@
+require 'date'
+require 'active_support/core_ext/string/inflections'
+
+module Transcriber
+  autoload :Resource, 'transcriber/resource'
+end

data/spec/resource/embeddables_spec.rb

@@ -0,0 +1,228 @@
+require 'spec_helper'
+
+describe Transcriber::Resource::Embeddables do
+  module RelationsExample
+    class Item < Transcriber::Resource
+    end
+
+    class Root < Transcriber::Resource
+    end
+  end
+
+  before do
+    RelationsExample::Root.keys.clear
+    RelationsExample::Item.keys.clear
+  end
+
+  describe ".embeds_one" do
+    it "creates a relation" do
+      module RelationsExample
+        class Item < Transcriber::Resource
+          property :id
+        end
+
+        class Root < Transcriber::Resource
+          embeds_one :item
+        end
+      end
+
+      RelationsExample::Root.keys.first.name.should == :item
+    end
+
+    it "defines an attr_accessor with relation name" do
+      module RelationsExample
+        class Item < Transcriber::Resource
+          property :id
+        end
+
+        class Root < Transcriber::Resource
+          embeds_one :item
+        end
+      end
+
+      RelationsExample::Root.new.tap do |r|
+        r.item = RelationsExample::Item.new(id: 2)
+        r.item.id.should == 2
+      end
+    end
+
+    context "configures class name" do
+      it "uses class_name option if defined" do
+        module RelationsExample
+          class Item < Transcriber::Resource
+            property :id
+          end
+
+          class Root < Transcriber::Resource
+            embeds_one :item, class_name: 'relations_example/item'
+          end
+        end
+
+        RelationsExample::Root.keys.first.class_name.should == 'RelationsExample::Item'
+      end
+
+      it "uses relation name if class_name option not defined" do
+        module RelationsExample
+          class Item < Transcriber::Resource
+            property :id
+          end
+
+          class Root < Transcriber::Resource
+            embeds_one :item
+          end
+        end
+
+        RelationsExample::Root.keys.first.class_name.should == 'Item'
+      end
+    end
+
+    it "configures relation start key if defined" do
+      module RelationsExample
+        class Item < Transcriber::Resource
+          property :id
+        end
+
+        class Root < Transcriber::Resource
+          embeds_one :item, start_key: :item_sap
+        end
+      end
+
+      RelationsExample::Root.keys.first.start_key.should == :item_sap
+    end
+
+    it "relation.one? => true and relation.many? => false" do
+      module RelationsExample
+        class Item < Transcriber::Resource
+          property :id
+        end
+
+        class Root < Transcriber::Resource
+          embeds_one :item
+        end
+      end
+
+      RelationsExample::Root.keys.first.should be_one
+      RelationsExample::Root.keys.first.should_not be_many
+    end
+
+    it "sets extra options if defined" do
+      module RelationsExample
+        class Item < Transcriber::Resource
+          property :id
+        end
+
+        class Root < Transcriber::Resource
+          embeds_one :item, restricted: 'admin'
+        end
+      end
+
+      RelationsExample::Root.keys.first.options[:restricted].should == 'admin'
+    end
+  end
+
+  describe ".embeds_many" do
+    it "creates a relation" do
+      module RelationsExample
+        class Item < Transcriber::Resource
+          property :id
+        end
+
+        class Root < Transcriber::Resource
+          embeds_many :item
+        end
+      end
+
+      RelationsExample::Root.keys.first.name.should == :item
+    end
+
+    it "defines an attr_accessor with relation name" do
+      module RelationsExample
+        class Item < Transcriber::Resource
+          property :id
+        end
+
+        class Root < Transcriber::Resource
+          embeds_many :item
+        end
+      end
+
+      RelationsExample::Root.new.tap do |r|
+        r.item = RelationsExample::Item.new(id: 2)
+        r.item.id.should == 2
+      end
+    end
+
+    context "configures class name" do
+      it "uses class_name option if defined" do
+        module RelationsExample
+          class Item < Transcriber::Resource
+            property :id
+          end
+
+          class Root < Transcriber::Resource
+            embeds_many :item, class_name: 'relations_example/item'
+          end
+        end
+
+        RelationsExample::Root.keys.first.class_name.should == 'RelationsExample::Item'
+      end
+
+      it "uses relation name if class_name option not defined" do
+        module RelationsExample
+          class Item < Transcriber::Resource
+            property :id
+          end
+
+          class Root < Transcriber::Resource
+            embeds_many :item
+          end
+        end
+
+        RelationsExample::Root.keys.first.class_name.should == 'Item'
+      end
+    end
+
+    it "configures relation start key if defined" do
+      module RelationsExample
+        class Item < Transcriber::Resource
+          property :id
+        end
+
+        class Root < Transcriber::Resource
+          embeds_many :item, start_key: :item_sap
+        end
+      end
+
+      RelationsExample::Root.keys.first.start_key.should == :item_sap
+    end
+
+    it "relation.one? => false and relation.many? => true" do
+      module RelationsExample
+        class Item < Transcriber::Resource
+          property :id
+        end
+
+        class Root < Transcriber::Resource
+          embeds_many :item
+        end
+      end
+
+      RelationsExample::Root.keys.first.should_not be_one
+      RelationsExample::Root.keys.first.should be_many
+    end
+
+    it "sets extra options if defined" do
+      module RelationsExample
+        class Item < Transcriber::Resource
+          property :id
+        end
+
+        class Root < Transcriber::Resource
+          embeds_many :item, restricted: 'admin'
+        end
+      end
+
+      RelationsExample::Root.keys.first.options[:restricted].should == 'admin'
+    end
+  end
+end

data/spec/resource/parser_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe Transcriber::Resource::Parser do
+  class Example < Transcriber::Resource
+  end
+
+  before { Example.keys.clear }
+
+  describe '.parse' do
+    it 'parses simple properties' do
+      class Example < Transcriber::Resource
+        property :login
+      end
+
+      models = Example.parse({'LOGIN' => 'jackiechan2010'})
+      models.should be_an(Array)
+      models.first.login.should == 'jackiechan2010'
+    end
+
+    it 'uses different field name if defined' do
+      class Example < Transcriber::Resource
+        property :login, field: :customer_login
+      end
+
+      models = Example.parse({'CUSTOMER_LOGIN' => 'jackiechan2010'})
+      models.should be_an(Array)
+      models.first.login.should == 'jackiechan2010'
+    end
+
+    context "uses type defined" do
+      context 'boolean' do
+        before do
+          class Example < Transcriber::Resource
+            property :can_merge, type: Boolean
+          end
+        end
+
+        it "returns true when value is 'X'" do
+          models = Example.parse({'CAN_MERGE' => 'X'})
+          models.first.can_merge.should be_true
+        end
+
+        it "returns false when value isn't 'X'" do
+          models = Example.parse({'CAN_MERGE' => ''})
+          models.first.can_merge.should be_false
+        end
+      end
+
+      context "date" do
+        it "parse" do
+          class Example < Transcriber::Resource
+            property :issue_date, type: Date
+          end
+
+          models = Example.parse({'ISSUE_DATE' => '2011-01-01'})
+          models.first.issue_date.should == Date.parse('2011-01-01')
+        end
+      end
+
+      context "float" do
+        it "parse" do
+          class Example < Transcriber::Resource
+            property :amount, type: Float
+          end
+
+          models = Example.parse({'AMOUNT' => '1234.5'})
+          models.first.amount.should == 1234.5
+        end
+      end
+    end
+
+    context "maps values if defined" do
+      before do
+        class Example < Transcriber::Resource
+          property :status, values: {paid: '01', unpaid: '02'}
+        end
+      end
+
+      it "returns key when value was mapped" do
+        models = Example.parse({'STATUS' => '02'})
+        models.first.status.should == :unpaid
+      end
+
+      it "returns nil when value wasn't mapped" do
+        models = Example.parse({'STATUS' => '03'})
+        models.first.status.should be_nil
+      end
+    end
+  end
+end

data/spec/resource/properties_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Transcriber::Resource::Properties do
+  class Example < Transcriber::Resource
+  end
+
+  before { Example.keys.clear }
+
+  describe ".property" do
+    it "creates a property" do
+      class Example
+        property :login
+      end
+
+      Example.keys.first.name.should == :login
+    end
+
+    it "defines an attr_accessor with property name" do
+      class Example
+        property :id
+      end
+
+      Example.new.tap do |example|
+        example.id = 2020
+        example.id.should == 2020
+      end
+    end
+
+    it "configures a default serializer" do
+      class Example
+        property :login
+      end
+
+      Example.keys.first.serializer.should == Transcriber::Resource::Serialization::String
+    end
+
+    it "configures a default field" do
+      class Example
+        property :login
+      end
+
+      Example.keys.first.field.should == "LOGIN"
+    end
+
+    it "sets property type if defined" do
+      class Example
+        property :login, type: Transcriber::Resource::Serialization::Date
+      end
+
+      Example.keys.first.serializer.should == Transcriber::Resource::Serialization::Date
+    end
+
+    it "sets property values if defined" do
+      class Example
+        property :login, values: {a: '1', b: '2'}
+      end
+
+      Example.keys.first.values.should == {a: '1', b: '2'}
+    end
+
+    it "sets extra options if defined" do
+      class Example
+        property :login, restricted: 'admin'
+      end
+
+      Example.keys.first.options[:restricted].should == 'admin'
+    end
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Transcriber::Resource do
+  class ExampleResources < Transcriber::Resource
+    property :login
+    property :name
+    property :age, type: Float
+  end
+
+  describe '#resource' do
+    it "returns a hash with properties and its values" do
+      example = ExampleResources.new(login: 'jackiechan2010', name: 'Jackie Chan', age: 45)
+      example.resource.should ==    {login: 'jackiechan2010', name: 'Jackie Chan', age: 45}
+    end
+  end
+
+  describe '.resources' do
+    it "returns a hash with entries" do
+      entries = [ExampleResources.new(login: 'jackiechan2010', name: 'Jackie Chan', age: 45),
+                 ExampleResources.new(login: 'brucelee',       name: 'Bruce Lee',   age: 10)]
+
+      resources = ExampleResources.resources(entries)
+      resources.should == {entries: [{login: 'jackiechan2010', name: 'Jackie Chan', age: 45},
+                                     {login: 'brucelee',       name: 'Bruce Lee',   age: 10}]}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'transcriber'

data/transcriber.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "transcriber/version"
+
+Gem::Specification.new do |s|
+  s.name        = "transcriber"
+  s.version     = Transcriber::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Victor Rodrigues",              "William Yokoi"]
+  s.email       = ["victorcrodrigues@gmail.com",    "thekina@gmail.com"]
+  s.homepage    = "http://github.com/rodrigues/transcriber"
+  s.summary     = %q{}
+  s.description = %q{}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activesupport", "~> 3.0"
+  s.add_development_dependency "rspec", "~> 2.6"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: transcriber
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Victor Rodrigues
+- William Yokoi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-31 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+  type: :development
+  version_requirements: *id002
+description: ""
+email: 
+- victorcrodrigues@gmail.com
+- thekina@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/transcriber.rb
+- lib/transcriber/resource.rb
+- lib/transcriber/resource/embeddables.rb
+- lib/transcriber/resource/embeddables/embeddable.rb
+- lib/transcriber/resource/embeddables/parser.rb
+- lib/transcriber/resource/embeddables/resource.rb
+- lib/transcriber/resource/parser.rb
+- lib/transcriber/resource/properties.rb
+- lib/transcriber/resource/properties/parser.rb
+- lib/transcriber/resource/properties/property.rb
+- lib/transcriber/resource/properties/resource.rb
+- lib/transcriber/resource/responses.rb
+- lib/transcriber/resource/serialization.rb
+- lib/transcriber/resource/serialization/boolean.rb
+- lib/transcriber/resource/serialization/date.rb
+- lib/transcriber/resource/serialization/float.rb
+- lib/transcriber/resource/serialization/string.rb
+- lib/transcriber/version.rb
+- spec/resource/embeddables_spec.rb
+- spec/resource/parser_spec.rb
+- spec/resource/properties_spec.rb
+- spec/resource_spec.rb
+- spec/spec_helper.rb
+- transcriber.gemspec
+has_rdoc: true
+homepage: http://github.com/rodrigues/transcriber
+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.6.2
+signing_key: 
+specification_version: 3
+summary: ""
+test_files: 
+- spec/resource/embeddables_spec.rb
+- spec/resource/parser_spec.rb
+- spec/resource/properties_spec.rb
+- spec/resource_spec.rb
+- spec/spec_helper.rb