transcriber 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,4 @@
+.rvmrc
 *.gem
 .bundle
 Gemfile.lock

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'rspec', cli: '--color' do
+  watch(%r{spec/spec_helper.rb})                       { "spec" }
+  watch(%r{^config\/(.*\/)*.*\.rb$})                   { "spec" }
+
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})                           { |m| "spec/#{m[1]}_spec.rb" }
+end

data/README.md

@@ -0,0 +1,39 @@
+# Transcriber
+
+
+## Installation
+
+  gem install transciber
+
+## Usage
+
+[See Examples](https://github.com/rodrigues/transcriber/tree/master/examples)
+
+## Maintainers
+
+* [Victor Rodrigues](http://github.com/rodrigues)
+* [William "Kina"](http://github.com/kina)
+* [Guilherme Guimarães Filho](http://github.com/gguimaraesbr)
+
+## License
+
+(The 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/examples/all.rb

@@ -0,0 +1,14 @@
+$:.push 'lib'; require 'transcriber'
+
+Dir["examples/*/**.rb"].each do |file|
+  [:Root, :Item, :Customer, :Entry].each do |klass|
+    Object.send(:remove_const, klass) if Object.const_defined? klass
+  end
+
+  puts
+  puts
+  p "example file: #{file}"
+  puts
+  puts
+  load file
+end

data/examples/embeds_many/simple.rb

@@ -0,0 +1,14 @@
+$:.push 'lib'; require 'transcriber'
+
+class Item < Transcriber::Resource
+  property :id
+end
+
+class Root < Transcriber::Resource
+  embeds_many :items
+end
+
+root = Root.parse({"items" => [{"id" => 2000}]}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/examples/embeds_many/with_class_name.rb

@@ -0,0 +1,14 @@
+$:.push 'lib'; require 'transcriber'
+
+class Entry < Transcriber::Resource
+  property :id
+end
+
+class Root < Transcriber::Resource
+  embeds_many :items, class_name: :entry
+end
+
+root = Root.parse({"items" => [{"id" => 2000}]}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/examples/embeds_many/with_if.rb

@@ -0,0 +1,21 @@
+$:.push 'lib'; require 'transcriber'
+
+class Item < Transcriber::Resource
+  property :id
+end
+
+class Root < Transcriber::Resource
+  property :id
+  embeds_many :items, if: proc {id == "10"}
+end
+
+root = Root.parse({"id" => 10, "items" => [{"id" => 2000}]}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"
+
+
+root = Root.parse({"id" => 1, "items" => [{"id" => 2000}]}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/examples/embeds_many/with_start_key.rb

@@ -0,0 +1,17 @@
+require 'json'
+
+$:.push 'lib'; require 'transcriber'
+
+class Item < Transcriber::Resource
+  property :id, field: :item_id
+end
+
+class Root < Transcriber::Resource
+  embeds_many :items, start_key: 'detalhe.itens'
+end
+
+root = Root.parse({"detalhe" => {"itens" => [{"item_id" => 2000}]}}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"
+puts "to_json:  #{root.resource.to_json}"

data/examples/embeds_one/simple.rb

@@ -0,0 +1,14 @@
+$:.push 'lib'; require 'transcriber'
+
+class Root < Transcriber::Resource
+  embeds_one :item
+end
+
+class Item < Transcriber::Resource
+  property :id
+end
+
+root = Root.parse({"item" => {"id" => 2000}}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/examples/embeds_one/with_class_name.rb

@@ -0,0 +1,14 @@
+$:.push 'lib'; require 'transcriber'
+
+class Entry < Transcriber::Resource
+  property :id
+end
+
+class Root < Transcriber::Resource
+  embeds_one :item, class_name: :entry
+end
+
+root = Root.parse({"item" => {"id" => 2000}}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/examples/embeds_one/with_if.rb

@@ -0,0 +1,21 @@
+$:.push 'lib'; require 'transcriber'
+
+class Root < Transcriber::Resource
+  property :id
+  embeds_one :item, if: proc {id == "1"}
+end
+
+class Item < Transcriber::Resource
+  property :id
+end
+
+root = Root.parse({"id"=> 1, "item" => {"id" => 2000}}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"
+
+
+root = Root.parse({"id"=> 100, "item" => {"id" => 2000}}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/examples/embeds_one/with_start_key.rb

@@ -0,0 +1,14 @@
+$:.push 'lib'; require 'transcriber'
+
+class Root < Transcriber::Resource
+  embeds_one :item, start_key: :ugly_nesting_key
+end
+
+class Item < Transcriber::Resource
+  property :id
+end
+
+root = Root.parse({"ugly_nesting_key" => {"id" => 2000}}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/examples/has_many/simple.rb

@@ -0,0 +1,29 @@
+$:.push 'lib'; require 'transcriber'
+
+class Service < Transcriber::Resource
+  property :name
+  belongs_to :customer
+end
+
+class Billing < Transcriber::Resource
+  property :login
+  belongs_to :customer
+end
+
+class Developer < Transcriber::Resource
+  property :login
+  belongs_to :customer
+end
+
+class Customer < Transcriber::Resource
+  id field: :customer_id
+  property :login
+  has_many :services
+  has_one :billing
+  has_one :devopada, class_name: :developer
+end
+
+@root = Customer.parse({"customer_id" => 123, "login" => 2000}).first
+
+puts "root:     #{@root.inspect}"
+puts "resource: #{@root.resource}"

data/examples/properties/simple.rb

@@ -0,0 +1,10 @@
+$:.push 'lib'; require 'transcriber'
+
+class Customer < Transcriber::Resource
+  property :login
+end
+
+root = Customer.parse({"login" => 2000}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/examples/properties/with_field.rb

@@ -0,0 +1,10 @@
+$:.push 'lib'; require 'transcriber'
+
+class Customer < Transcriber::Resource
+  property :login, field: :customer_login
+end
+
+root = Customer.parse({"customer_login" => 2000}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/examples/properties/with_field_path.rb

@@ -0,0 +1,10 @@
+$:.push 'lib'; require 'transcriber'
+
+class Customer < Transcriber::Resource
+  property :login, field: 'hidden.login'
+end
+
+root = Customer.parse({"hidden" => {"login" => 2000}}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/examples/properties/with_id.rb

@@ -0,0 +1,10 @@
+$:.push 'lib'; require 'transcriber'
+
+class Customer < Transcriber::Resource
+  id
+end
+
+root = Customer.parse({"id" => 2000}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/examples/properties/with_if.rb

@@ -0,0 +1,19 @@
+$:.push 'lib'; require 'transcriber'
+
+class Customer < Transcriber::Resource
+  property :login
+  property :password
+  property :some_text, if: proc {password == "abc"}
+end
+
+root = Customer.parse({"login" => 2000, "password" => "abc", "some_text" => "some text"}).first
+
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"
+
+
+root = Customer.parse({"login" => 2000, "password" => "abcd", "some_text" => "some text II"}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/examples/properties/with_key_converter.rb

@@ -0,0 +1,20 @@
+$:.push 'lib'; require 'transcriber'
+
+module Upcasing
+  def self.call(keys)
+    keys.map {|key| key.to_s.upcase}
+  end
+end
+
+Transcriber.configure do |c|
+  c.convert_input_keys = Upcasing
+end
+
+class Customer < Transcriber::Resource
+  property :login
+end
+
+root = Customer.parse({"LOGIN" => 2000}).first
+
+puts "root:     #{root.inspect}"
+puts "resource: #{root.resource}"

data/lib/transcriber/configuration.rb

@@ -0,0 +1,13 @@
+module Transcriber
+  class Configuration
+    DefaultHandler = lambda {|keys| keys.map(&:to_s)}
+
+    def convert_input_keys
+      @convert_input_keys || DefaultHandler
+    end
+
+    def convert_input_keys=(converter)
+      @convert_input_keys = converter
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Transcriber
+  class Resource
+    module Builder
+      module Embeddables
+        def embeds(name, options)
+          key 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
+  end
+end

data/lib/transcriber/resource/builder/keys.rb

@@ -0,0 +1,20 @@
+module Transcriber
+  class Resource
+    module Builder
+      module Keys
+        def key(key)
+          fail "you can't define a key with name '#{key.name}'" if not_allowed?(key)
+          attr_accessor key.name
+          self.keys  << key
+          self.id_key = key if key.options[:id]
+        end
+
+        private
+
+        def not_allowed?(key)
+          Resource.not_allowed_names.include?(key.name.to_s)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Transcriber
+  class Resource
+    module Builder
+      module Properties
+        def property(name, options = {})
+          key Property.new(name, options)
+        end
+
+        def properties(*args)
+          options = options(args)
+          names = args
+          names.each {|name| property(name, options)}
+        end
+
+        def id(*args)
+          options = options(args)
+          name = args.fetch(0, :id)
+          property(name, options.merge(id: true))
+        end
+
+        private
+
+        def options(args)
+          args.last.kind_of?(Hash) ? args.pop : {}
+        end
+      end
+    end
+  end
+end

data/lib/transcriber/resource/builder/relations.rb

@@ -0,0 +1,26 @@
+module Transcriber
+  class Resource
+    module Builder
+      module Relations
+        def relation(name, options)
+          key Relation.new(name, options)
+        end
+
+        def has_one(name, options = {})
+          options.merge!(many: false, has: true)
+          relation(name, options)
+        end
+
+        def has_many(name, options = {})
+          options.merge!(many: true, has: true)
+          relation(name, options)
+        end
+
+        def belongs_to(name, options = {})
+          options.merge!(many: false, has: false)
+          relation(name, options)
+        end
+      end
+    end
+  end
+end

data/lib/transcriber/resource/builder/summarizations.rb

@@ -0,0 +1,14 @@
+module Transcriber
+  class Resource
+    module Builder
+      module Summarization
+        def summarizes(*args = [])
+          args.each do |name|
+            key = keys.find {|key| key.name == name}
+            key.summarize = true if key
+          end
+        end
+      end
+    end
+  end
+end

data/lib/transcriber/resource/builder.rb

@@ -0,0 +1,10 @@
+module Transcriber
+  class Resource
+    module Builder
+      include Keys
+      include Relations
+      include Embeddables
+      include Properties
+    end
+  end
+end

data/lib/transcriber/resource/input_path.rb

@@ -0,0 +1,19 @@
+module Transcriber
+  class Resource
+    module InputPath
+      def self.resolve(options, convert_input_keys = Key::Converter::DefaultHandler)
+        convert_input_keys.call keys_for_path(custom_path(options))
+      end
+
+      private
+
+      def self.custom_path(options)
+        options.slice(:start_key, :field)
+      end
+
+      def self.keys_for_path(path)
+        path.empty? ? [] : path.values.first.to_s.split('.')
+      end
+    end
+  end
+end

data/lib/transcriber/resource/key/association.rb

@@ -0,0 +1,29 @@
+module Transcriber
+  class Resource
+    class Association < Key
+      attr_reader :many
+
+      def initialize(name, options = {})
+        super
+        @many       = options.fetch(:many, false)
+        @class_name = options.fetch(:class_name, default_class_name).to_s.camelize
+      end
+
+      def one?
+        !many?
+      end
+
+      def many?
+        @many
+      end
+
+      def default_class_name
+        one? ? name : name.to_s.singularize
+      end
+
+      def resource_class
+        @class_name.constantize
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Transcriber
+  class Resource
+    class Embeddable < Association
+      include Parser::Embeddable
+      include Response::Embeddable
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Transcriber
+  class Resource
+    class Property < Key
+      include Parser::Property
+      include Response::Property
+
+      attr_accessor :serializer
+      attr_accessor :translations
+
+      def initialize(name, options = {})
+        super
+        @serializer   = options.fetch(:type, Serialization::String)
+        @translations = options[:values].try(:invert)
+      end
+    end
+  end
+end

data/lib/transcriber/resource/key/relation.rb

@@ -0,0 +1,24 @@
+module Transcriber
+  class Resource
+    class Relation < Association
+      include Response::Relation
+
+      def initialize(name, options = {})
+        super
+        @has = options.fetch(:has, false)
+      end
+
+      def has?
+        @has
+      end
+
+      def belongs?
+        !has?
+      end
+
+      def parse(value)
+        nil
+      end
+    end
+  end
+end

data/lib/transcriber/resource/key.rb

@@ -0,0 +1,29 @@
+module Transcriber
+  class Resource
+    class Key
+      attr_accessor :name
+      attr_accessor :options
+      attr_accessor :summarize
+
+      def initialize(name, options = {})
+        @name    = name
+        @options = options
+      end
+
+      def present?(resource)
+        return true unless options[:if]
+        resource.instance_eval &options[:if]
+      end
+
+      def input_path
+        return @input_path if @input_path
+        path = InputPath.resolve(options, convert_input_keys)
+        @input_path = path.empty? ? convert_input_keys.call([name]) : path
+      end
+
+      def convert_input_keys
+        options.fetch(:convert_input_keys, Transcriber.configuration.convert_input_keys)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Transcriber
+  class Resource
+    module Parser
+      module Embeddable
+        def parse(value)
+          parsed_value = resource_class.parse(value)
+          one? ? parsed_value.first : parsed_value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Transcriber
+  class Resource
+    module Parser
+      module Property
+        def parse(value)
+          translate serializer.serialize(value)
+        end
+
+        def translate(value)
+          translations ? translations[value] : value
+        end
+      end
+    end
+  end
+end