rest_model 0.1.0

data/examples/properties/with_two_key_converters.rb

@@ -0,0 +1,27 @@
+$:.push 'examples'; require 'helper'
+
+module Upcasing
+  def self.call(keys)
+    keys.map {|key| key.to_s.upcase}
+  end
+end
+
+module Camelizing
+  def self.call(keys)
+    keys.map {|key| key.to_s.camelize}
+  end
+end
+
+class Customer < RestModel
+  convert_input_keys Upcasing
+  property :login
+  embeds_one :product
+end
+
+class Product < RestModel
+  convert_input_keys Camelizing
+  property :unit_price, type: Float
+end
+
+@root = Customer.parse({"LOGIN" => 'jackiechan2010', "PRODUCT" => {"UnitPrice" => 29.9}}).first
+inspect_rest_model(@root)

data/examples/properties/with_values.rb

@@ -0,0 +1,10 @@
+$:.push 'examples'; require 'helper'
+
+class Customer < RestModel
+  property :periodicity, values: {1 => "c_53", 2 => "c_z1"}
+  property :company,     values: {"amazon" => "AM", "google" => "GOOG"}
+  property :type,        values: {simple: "1", complex: "2"}
+end
+
+@root = Customer.parse({periodicity: 'c_53', company: "GOOG", type: 2}).first
+inspect_rest_model(@root)

data/examples/summarization/simple.rb

@@ -0,0 +1,21 @@
+$:.push 'examples'; require 'helper'
+
+class Customer < RestModel
+  convert_input_keys proc {|keys| keys}
+
+  id
+  properties :login, :name, :postal_code, :email, :secondary_email
+  summarizes :id, :login
+end
+
+input = {
+  "id"    =>           138911938,
+  "login" =>           'jackiechan2010',
+  "name"  =>           'jackie chan',
+  "postal_code" =>     '05492-092',
+  "email" =>           'jachan@gmail.com',
+  "secondary_email" => 'jackiepeligroso@yahoo.com'
+}
+
+@root = Customer.resources Customer.parse(input)
+puts "transcribed: #{@root}"

data/examples/to_input/embeds_many.rb

@@ -0,0 +1,25 @@
+$:.push 'examples'; require 'helper'
+
+class Customer < RestModel
+  property :login, field: 'hidden.login'
+  embeds_many :phones
+end
+
+class Phone < RestModel
+  properties :number, :extension
+end
+
+@root = Customer.new({
+  login: 'jackiechan2010',
+  phones: [
+    {
+      number: "123123123",
+      extension: "111"
+    },
+    {
+      number: "098098098",
+      extension: "999"
+    }
+  ]})
+
+inspect_rest_model(@root)

data/examples/to_input/embeds_many_without_key.rb

@@ -0,0 +1,31 @@
+$:.push 'examples'; require 'helper'
+
+class Customer < RestModel
+  properties :login, :name
+  embeds_many :phones
+end
+
+class Phone < RestModel
+  properties :number, :extension, :description
+end
+
+@root = Customer.new({
+  login: 'jackiechan2010',
+  name: "Jackie Chan",
+  phones: [
+   {
+     number: "897289472",
+     extension: "3897",
+     description: "abab"
+   },
+   {
+     number: "987198732",
+     extension: "1897",
+     description: "eheh"
+   }
+  ]
+})
+
+inspect_rest_model(@root)
+
+puts "to input without description: #{@root.to_input(phones: {without: :descriptions})}"

data/examples/to_input/embeds_one.rb

@@ -0,0 +1,13 @@
+$:.push 'examples'; require 'helper'
+
+class Customer < RestModel
+  property :login, field: 'hidden.login'
+  embeds_one :address
+end
+
+class Address < RestModel
+  properties :street, :number
+end
+
+@root = Customer.new(login: 'jackiechan2010', address: {street: "Aurora St", number: 666})
+inspect_rest_model(@root)

data/examples/to_input/embeds_one_without_key.rb

@@ -0,0 +1,23 @@
+$:.push 'examples'; require 'helper'
+
+class Customer < RestModel
+  properties :login, :name
+  embeds_one :address
+end
+
+class Address < RestModel
+  properties :street, :number, :hint
+end
+
+@root = Customer.new({
+  login: 'jackiechan2010',
+  name: "Jackie Chan",
+  address: {
+    street: "Aurora St",
+    number: 1833,
+    hint: "near gas station"
+  }
+})
+
+inspect_rest_model(@root)
+puts "root.to_input without hint: #{@root.to_input(address: {without: :hint})}"

data/examples/to_input/flattened.rb

@@ -0,0 +1,12 @@
+$:.push 'examples'; require 'helper'
+
+class Root < RestModel
+  embeds_one :item, start_key: ""
+end
+
+class Item < RestModel
+  property :id
+end
+
+@root = Root.new(item: {id: 2000})
+inspect_rest_model(@root)

data/examples/to_input/serializables.rb

@@ -0,0 +1,19 @@
+$:.push 'examples'; require 'helper'
+
+RestModel::Configuration.configure do |c|
+  c.true_value = "X"
+  c.false_value = ""
+  c.date_format = "%Y%m%d"
+end
+
+class Customer < RestModel
+  property :login
+  property :age,      type: Integer
+  property :birth,    type: Date
+  property :active,   type: Boolean
+  property :services, type: Enumerable
+  property :balance,  type: Float
+end
+
+@root = Customer.new({login: 'jackiechan2010', age: 22, birth: "1990-07-04", active: true, services: ["Hosting", "Email"], balance: 200.00})
+inspect_rest_model(@root)

data/examples/to_input/simple.rb

@@ -0,0 +1,8 @@
+$:.push 'examples'; require 'helper'
+
+class Customer < RestModel
+  property :login
+end
+
+@root = Customer.new(login: 'jackiechan2010')
+inspect_rest_model(@root)

data/examples/to_input/with_field.rb

@@ -0,0 +1,8 @@
+$:.push 'examples'; require 'helper'
+
+class Customer < RestModel
+  property :login, field: 'customer_login'
+end
+
+@root = Customer.new(login: 'jackiechan2010')
+inspect_rest_model(@root)

data/examples/to_input/with_field_path.rb

@@ -0,0 +1,8 @@
+$:.push 'examples'; require 'helper'
+
+class Customer < RestModel
+  property :login, field: 'hidden.login'
+end
+
+@root = Customer.new(login: 'jackiechan2010')
+inspect_rest_model(@root)

data/examples/to_input/with_fields.rb

@@ -0,0 +1,8 @@
+$:.push 'examples'; require 'helper'
+
+class Root < RestModel
+  embeds_many :items, fields: [:item1, :item2, :item3, :item4]
+end
+
+@root = Root.new(items: %w(i1 i2 i3))
+inspect_rest_model(@root)

data/examples/to_input/without_key.rb

@@ -0,0 +1,11 @@
+$:.push 'examples'; require 'helper'
+
+class Customer < RestModel
+  property :login
+  property :name
+end
+
+@root = Customer.new(login: 'jackiechan2010', name: "Jackie Chan")
+
+puts "root.to_input: #{@root.to_input(without: :name)}"
+inspect_rest_model(@root)

data/examples/to_input/without_nil.rb

@@ -0,0 +1,11 @@
+$:.push 'examples'; require 'helper'
+
+class Customer < RestModel
+  property :login
+  property :name
+end
+
+@root = Customer.new(login: 'jackiechan2010')
+inspect_rest_model(@root)
+puts "root.to_input without nil: #{@root.to_input(without_nil: true)}"
+

data/lib/rest_model/configuration.rb

@@ -0,0 +1,45 @@
+class RestModel
+  module Configuration
+    extend self
+
+    attr_accessor :host
+
+    DefaultHandler = proc {|keys| keys}
+
+    def convert_input_keys
+      @convert_input_keys || DefaultHandler
+    end
+
+    def convert_input_keys=(converter)
+      @convert_input_keys = converter
+    end
+
+    def true_value
+      @true || true
+    end
+
+    def true_value=(value)
+      @true = value
+    end
+
+    def false_value
+      @false || false
+    end
+
+    def false_value=(value)
+      @false = value
+    end
+
+    def date_format
+      @date_format
+    end
+
+    def date_format=(format)
+      @date_format = format
+    end
+
+    def configure
+      yield self if block_given?
+    end
+  end
+end

data/lib/rest_model/key/association.rb

@@ -0,0 +1,42 @@
+class RestModel
+  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.to_s.camelize.constantize
+    end
+
+    def from_hash(attrs, resource = nil)
+      return nil if attrs.nil? or attrs.empty?
+      resource ? update_from_hash(resource, attrs) : create_from_hash(attrs)
+    end
+
+    def create_from_hash(attrs)
+      one? ? resource_class.new(attrs)
+           : Array(attrs).map {|item| resource_class.new(item)}
+    end
+
+    def update_from_hash(resource, attrs)
+      one? ? resource.update_attributes(attrs)
+           : resource.map {|item| item.update_attributes(item)}
+    end
+  end
+end

data/lib/rest_model/key/builder.rb

@@ -0,0 +1,30 @@
+class RestModel
+  class Key
+    module Builder
+      include Relation::Builder
+      include Embeddable::Builder
+      include Property::Builder
+
+      def key(key)
+        fail "you can't define a key with name '#{key.name}'" if not_allowed?(key)
+        key.model = self
+        attr_accessor key.name
+        self.keys  << key
+        self.id_key = key if key.options[:id]
+      end
+
+      def summarizes(*args)
+        args.each do |name|
+          key = keys.find {|key| key.name == name}
+          summarized_keys << key if key
+        end
+      end
+
+      private
+
+      def not_allowed?(key)
+        RestModel.not_allowed_names.include?(key.name.to_s)
+      end
+    end
+  end
+end

data/lib/rest_model/key/embeddable/builder.rb

@@ -0,0 +1,19 @@
+class RestModel
+  class Embeddable
+    module Builder
+      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

data/lib/rest_model/key/embeddable/response.rb

@@ -0,0 +1,25 @@
+class RestModel
+  class Embeddable
+    module Response
+      def to_resource(parent)
+        return {} unless visible?(parent)
+
+        resource = nil
+
+        if embedded = parent.__send__(name)
+          resource = raw? ? embedded : resourcify(embedded)
+        elsif many?
+          resource = []
+        end
+
+        {name => resource}
+      end
+
+      private
+
+      def resourcify(embedded)
+        one? ? embedded.resource : embedded.map(&:resource)
+      end
+    end
+  end
+end

data/lib/rest_model/key/embeddable/retriever.rb

@@ -0,0 +1,20 @@
+class RestModel
+  class Embeddable
+    module Retriever
+      def from_source(item, resource = nil)
+        return handle_fields(item) if fields
+        value = digg(item)
+        parsed_value = raw? ? value : resource_class.from_source(value)
+        one? ? parsed_value.first : parsed_value
+      end
+
+      def handle_fields(item)
+        convert_input_keys.call(fields).map {|field| item[field]}
+      end
+
+      def digg(input)
+        source_path.inject(input) {|buffer, key| buffer = buffer[key]}
+      end
+    end
+  end
+end

data/lib/rest_model/key/embeddable/sender.rb

@@ -0,0 +1,41 @@
+class RestModel
+  class Embeddable
+    module Sender
+      def to_source!(value, resource, options = {})
+        return {} if value.nil?
+        fields ? to_multiple_source(value, options)
+               : to_single_source(value, options)
+      end
+
+      private
+
+      def to_single_source(value, options)
+        source = {}
+        path = source_path
+
+        if path.any?
+          last = path.pop
+          key_source = path.inject(source) {|buffer, key| buffer[key] = {}; buffer[key]}
+          key_source[last] = raw? ? value
+                                  : one? ? value.to_source(options)
+                                         : value.map {|item| item.to_source(options)}
+        else
+          source.merge!(value.to_source(options))
+        end
+
+        source
+      end
+
+      def to_multiple_source(value, options)
+        input = {}
+        mapped_fields = convert_input_keys.call(fields)
+
+        value.each_with_index do |item, index|
+          input[mapped_fields[index]] = item
+        end
+
+        input
+      end
+    end
+  end
+end

data/lib/rest_model/key/embeddable.rb

@@ -0,0 +1,29 @@
+class RestModel
+  class Embeddable < Association
+    autoload :Sender,    "rest_model/key/embeddable/sender"
+    autoload :Retriever, "rest_model/key/embeddable/retriever"
+    autoload :Response,  "rest_model/key/embeddable/response"
+    include   Sender
+    include   Retriever
+    include   Response
+
+    attr_accessor :fields
+
+    def initialize(name, options = {})
+      super
+
+      if fields = options[:fields]
+        @class_name = :array
+        @fields = fields
+      end
+    end
+
+    def raw?
+      [Hash, Array].include?(resource_class)
+    end
+
+    def from_hash(attrs, resource = nil)
+      raw? ? attrs : super
+    end
+  end
+end

data/lib/rest_model/key/href/response.rb

@@ -0,0 +1,10 @@
+class RestModel
+  class Href
+    module Response
+      def to_resource(parent)
+        id_key = parent.class.id_key.name
+        {name => "#{RestModel::Configuration.host}/#{parent.class.resource_name}/#{parent.send(id_key)}"}
+      end
+    end
+  end
+end

data/lib/rest_model/key/href.rb

@@ -0,0 +1,10 @@
+class RestModel
+  class Href < Key
+    autoload :Response, "rest_model/key/href/response"
+    include   Response
+
+    def initialize
+      super(:href)
+    end
+  end
+end

data/lib/rest_model/key/property/builder.rb

@@ -0,0 +1,27 @@
+class RestModel
+  class Property
+    module Builder
+      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

data/lib/rest_model/key/property/response.rb

@@ -0,0 +1,9 @@
+class RestModel
+  class Property
+    module Response
+      def to_resource(parent)
+        visible?(parent) ? {name => parent.__send__(name)} : {}
+      end
+    end
+  end
+end

data/lib/rest_model/key/property/retriever.rb

@@ -0,0 +1,24 @@
+class RestModel
+  class Property
+    module Retriever
+      def from_source(item, resource = nil)
+        value = digg(item)
+        translate_from_source(serializer.serialize(value), resource)
+      end
+
+      def digg(input)
+        source_path.inject(input) {|buffer, key| buffer = buffer[key]}
+      end
+
+      def translate_from_source(value, resource)
+        case translations
+        when nil  then value
+        when Proc then resource.instance_eval(&translations)
+        when Hash
+          fail "from input error" unless translations.has_value?(value)
+          translations.key(value)
+        end
+      end
+    end
+  end
+end

data/lib/rest_model/key/property/sender.rb

@@ -0,0 +1,41 @@
+class RestModel
+  class Property
+    module Sender
+      def to_source!(value, resource, options = {})
+        source_value = nil
+
+        begin
+          if translations
+            source_value = translate_to_source(value, resource)
+          else
+            source_value = serializer.desserialize(value)
+          end
+        rescue => exception
+          raise exception if options[:fail]
+        end
+
+        source = {}
+        path = source_path
+
+        if path.any?
+          last = path.pop
+          key_source = path.inject(source) {|buffer, key| buffer[key] = {}; buffer[key]}
+          key_source[last] = source_value
+        else
+          source.merge!(source_value)
+        end
+
+        source
+      end
+
+      def translate_to_source(value, resource)
+        case translations
+        when Proc then resource.instance_eval(&translations)
+        when Hash
+          fail "to input error" unless translations.has_key?(value)
+          translations[value]
+        end
+      end
+    end
+  end
+end

data/lib/rest_model/key/property.rb

@@ -0,0 +1,22 @@
+class RestModel
+  class Property < Key
+    autoload :Sender,    "rest_model/key/property/sender"
+    autoload :Retriever, "rest_model/key/property/retriever"
+    autoload :Response,  "rest_model/key/property/response"
+    include   Sender
+    include   Retriever
+    include   Response
+
+    attr_accessor :serializer, :translations
+
+    def initialize(name, options = {})
+      super
+      @serializer   = options.fetch(:type, Serialization::String)
+      @translations = options[:values]
+    end
+
+    def from_hash(value, resource = nil)
+      value
+    end
+  end
+end