simplifyapi 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 JH. Chabran
+
+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,29 @@
+# Simplifyapi
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simplifyapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simplifyapi
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/simplifyapi.rb

@@ -0,0 +1,10 @@
+require "simplifyapi/version"
+require "simplifyapi/property"
+require "simplifyapi/collection"
+require "simplifyapi/representation"
+require "simplifyapi/representer"
+require "simplifyapi/collection_representer"
+
+module Simplifyapi
+  # Your code goes here...
+end

data/lib/simplifyapi/builder.rb

@@ -0,0 +1,31 @@
+module Simplifyapi
+  class Builder
+    include DSLMethods
+
+    def export representer, model
+      @store = {}
+      @representer = representer
+      @model = model
+
+      # Registering keys and properties
+      @block.call(self, @model) if @block
+
+      hash = {}
+
+      # Then we play the score accordingly
+      @store.each do |key, object|
+        if object.is_a? Builder
+          hash[key] = object.export(representer, model)
+        else
+          if object.respond_to? :export
+            hash[key] = object.export(@model)
+          else
+            hash[key] = object
+          end
+        end
+      end
+
+      hash
+    end
+  end
+end

data/lib/simplifyapi/collection.rb

@@ -0,0 +1,56 @@
+module Simplifyapi
+  class Collection
+    def initialize name, representer, &block
+      @name = name
+      @representer = representer
+
+      instance_eval &block if block_given?
+    end
+
+    def import
+      raise "TODO"
+    end
+
+    # Depending on how you use a collection, it can
+    # be invoked with an array or with a model
+    # if you're defining nested collections
+    # like a has_many relationship
+    def export model_or_collection
+      if getter_defined?
+        result = @getter.call model_or_collection
+      else
+        if model_or_collection.is_a? Array
+          result = model_or_collection
+        else
+          result = model_or_collection.send(@name)
+        end
+      end
+
+      wrap_representers result
+    end
+
+    def wrap_representers collection
+      collection.map do |item|
+        @representer.export(item)
+      end
+    end
+
+    def getter_defined?
+      !!@getter
+    end
+
+    def setter_defined?
+      !!@setter
+    end
+
+    private
+    def get &block
+      @getter = block
+    end
+
+    def set &block
+      @setter = block
+    end
+  end
+end
+

data/lib/simplifyapi/collection_representer.rb

@@ -0,0 +1,43 @@
+require 'active_support/concern'
+require 'active_support/core_ext'
+
+module Simplifyapi
+  module CollectionRepresenter
+    extend ::ActiveSupport::Concern
+
+    def initialize collection
+      @collection = collection
+    end
+
+    def to_json
+      self.class.export(@collection).to_json
+    end
+
+
+    module ClassMethods
+      attr_reader :collection
+
+      def representer representer_klass
+        @collection = Collection.new(name, representer_klass)
+      end
+
+      def representation &block
+        return @representation unless block_given?
+
+        @representation = Representation.new &block
+      end
+
+      def export collection
+        @representation.export(self, collection)
+      end
+
+      def represents_model?
+        false
+      end
+
+      def represents_collection?
+        true
+      end
+    end
+  end
+end

data/lib/simplifyapi/dsl_methods.rb

@@ -0,0 +1,27 @@
+module Simplifyapi
+  module DSLMethods
+    def initialize &block
+      @block = block
+    end
+
+    def method_missing method_id, *args, &block
+      if args.length > 0 && !block_given?
+        @store[method_id] = args.first
+      else
+        @store[method_id] = self.class.new(&block)
+      end
+    end
+
+    def property name
+      @store[name] = @representer.properties[name.to_sym]
+    end
+
+    def collection name
+      if @representer.represents_model?
+        @store[name] = @representer.collections[name.to_sym]
+      else
+        @store[name] = @representer.collection
+      end
+    end
+  end
+end

data/lib/simplifyapi/importer.rb

@@ -0,0 +1,27 @@
+module Simplifyapi
+  class Importer
+    include DSLMethods
+
+    def import representer, model, hash
+      @store = {}
+      @representer = representer
+      @model = model
+
+      # Registering keys and properties
+      @block.call(self, @model) if @block
+
+      # Then we play the score accordingly
+      @store.each do |key, object|
+        if object.is_a? Importer
+          object.import representer, model, hash[key.to_s]
+        else
+          if hash && hash.has_key?(key) && object.respond_to?(:import)
+            object.import model, hash[key]
+          end
+        end
+      end
+
+      hash
+    end
+  end
+end

data/lib/simplifyapi/property.rb

@@ -0,0 +1,44 @@
+module Simplifyapi
+  class Property
+    attr_reader :name, :getter, :setter
+
+    def initialize name, &block
+      @name = name
+
+      instance_eval &block if block_given?
+    end
+
+    def import model, value
+      if setter_defined?
+        @setter.call model, value
+      else
+        model.send "#{name}=", value
+      end
+    end
+
+    def export model
+      if getter_defined?
+        @getter.call model
+      else
+        model.send name
+      end
+    end
+
+    def getter_defined?
+      !!@getter
+    end
+
+    def setter_defined?
+      !!@setter
+    end
+
+    private
+    def get &block
+      @getter = block
+    end
+
+    def set &block
+      @setter = block
+    end
+  end
+end

data/lib/simplifyapi/representation.rb

@@ -0,0 +1,22 @@
+require 'simplifyapi/dsl_methods'
+require 'simplifyapi/builder'
+require 'simplifyapi/importer'
+
+module Simplifyapi
+  class Representation
+    def initialize &block
+      @builder = Builder.new &block
+      @importer = Importer.new &block
+    end
+
+    def export representer, model
+      @builder.export representer, model
+    end
+
+    def import representer, model, hash
+      @importer.import representer, model, hash
+
+      model
+    end
+  end
+end

data/lib/simplifyapi/representer.rb

@@ -0,0 +1,58 @@
+require 'active_support/concern'
+require 'active_support/core_ext'
+
+module Simplifyapi
+  module Representer
+    extend ::ActiveSupport::Concern
+
+    def initialize model
+      @model = model
+    end
+
+    def to_json
+      self.class.export(@model).to_json
+    end
+
+    def from_json json
+      self.class.import @model, ActiveSupport::JSON.decode(json)
+    end
+
+    module ClassMethods
+      attr_reader :properties, :collections
+
+      def property name, &block
+        @properties ||= {}
+
+        @properties[name] = Property.new(name, &block)
+      end
+
+      def collection name, representer, &block
+        @collections ||= {}
+
+        @collections[name] = Collection.new(name, representer, &block)
+      end
+
+      def representation &block
+        return @representation unless block_given?
+
+        @representation = Representation.new &block
+      end
+
+      def export model
+        @representation.export(self, model)
+      end
+
+      def import model, hash
+        @representation.import(self, model, hash.with_indifferent_access)
+      end
+
+      def represents_model?
+        true
+      end
+
+      def represents_collection?
+        false
+      end
+    end
+  end
+end

data/lib/simplifyapi/version.rb

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

data/simplifyapi.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/simplifyapi/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["JH. Chabran"]
+  gem.email         = ["jh@chabran.fr"]
+  gem.description   = %q{Export and import json from a definable format}
+  gem.summary       = gem.description
+  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.name          = "simplifyapi"
+  gem.require_paths = ["lib"]
+  gem.version       = Simplifyapi::VERSION
+
+  gem.add_dependency 'activesupport', '~> 3.2.6'
+  gem.add_dependency 'rake'
+  gem.add_dependency 'i18n'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+end

data/spec/simplifyapi/representer_spec.rb

@@ -0,0 +1,399 @@
+require 'spec_helper'
+
+module Simplifyapi
+  describe Representer do
+    it "should declare a simple property" do
+      class Dummy
+        include Simplifyapi::Representer
+
+        property :title
+      end
+
+      Dummy.properties.should include(:title)
+    end
+
+    it "should declare a property with a getter" do
+      class Dummy
+        include Simplifyapi::Representer
+
+        property :title do
+          get do |model|
+            model.formatted_title
+          end
+        end
+      end
+
+
+      Dummy.properties[:title].getter_defined?.should be(true)
+    end
+
+    it "should declare a property with a setter" do
+      class Dummy
+        include Simplifyapi::Representer
+
+        property :title do
+          set do |model, value|
+            model.formatted_title = value
+          end
+        end
+      end
+
+      Dummy.properties[:title].setter_defined?.should be(true)
+    end
+
+    describe "Representation" do
+      before :each do
+        class Dummy
+          include Simplifyapi::Representer
+
+          property :title do
+            get do |model|
+              model.formatted_title
+            end
+
+            set do |model, value|
+              model.formatted_title = value
+            end
+          end
+
+          representation do |json|
+            json.meta do |meta|
+              meta.property :title
+            end
+          end
+        end
+      end
+
+      it "should declare a representation" do
+        Dummy.representation.should_not be_nil
+      end
+
+      it "should export json" do
+        hash = {meta:{title:"some title"}}
+
+        model = Struct.new(:formatted_title).new("some title")
+        Dummy.new(model).to_json.should ==(hash.to_json)
+      end
+
+      it "should import json" do
+        hash = {meta:{title:"some title"}}
+        model = Struct.new(:formatted_title).new
+
+        Dummy.new(model).from_json(hash.to_json).formatted_title.should ==("some title")
+      end
+    end
+
+    describe "Complex representation" do
+      before :each do
+        class Dummy
+          include Simplifyapi::Representer
+
+          property :title do
+            get do |model|
+              model.formatted_title
+            end
+
+            set do |model, value|
+              model.formatted_title = value
+            end
+          end
+
+          property :position do
+            get do |model|
+              {:x => model.position_x, :y => model.position_y}
+            end
+
+            set do |model, value|
+              model.position_x = value['x']
+              model.position_y = value['y']
+            end
+          end
+
+          representation do |json|
+            json.meta do |meta|
+              meta.property :title
+            end
+
+            json.property :position
+          end
+        end
+      end
+
+      it "should export json" do
+        hash = {:meta=>{:title => "test"}, :position => {:x => 4, :y => 5}}
+
+        model = Struct.new(:formatted_title, :position_x, :position_y).new("test", 4,5)
+
+        Dummy.new(model).to_json.should ==(hash.to_json)
+      end
+
+      it "should import json" do
+        hash = {:meta=>{:title => "test"}, :position => {:x => 4, :y => 5}}
+
+        model = Struct.new(:formatted_title, :position_x, :position_y).new
+
+        @model = Dummy.new(model).from_json(hash.to_json)
+        @model.formatted_title.should ==("test")
+        @model.position_x.should ==(4)
+        @model.position_y.should ==(5)
+      end
+    end
+
+    describe "Immediate values" do
+      before :each do
+        @hash = {:meta=>{:version => 4, :title => "test", :stuff => "stuff"}}
+        @model = Struct.new(:formatted_title, :stuff).new("test", "stuff")
+
+        class Dummy
+          include Simplifyapi::Representer
+
+          property :title do
+            get do |model|
+              model.formatted_title
+            end
+
+            set do |model, title|
+              model.formatted_title = title
+            end
+          end
+
+          representation do |json, model|
+            json.meta do |meta|
+              meta.version 4
+              meta.property :title
+              meta.stuff model.stuff
+            end
+          end
+        end
+      end
+
+      it "should export immediate values " do
+        Dummy.new(@model).to_json.should ==(@hash.to_json)
+      end
+
+      it "should ignore it when importing" do
+        Dummy.new(@model).from_json(@hash.to_json).formatted_title.should ==('test')
+      end
+
+      it "should not whine about it if it is absent" do
+        Dummy.new(@model).from_json(@hash.except(:meta).to_json)
+      end
+
+      it "should not import nil when a property isn't present" do
+        Dummy.import(@model, {:meta => {:version => 4}})
+        @model.formatted_title.should ==("test")
+      end
+    end
+  end
+
+  describe "Including a module" do
+    before :each do
+      @hash = {:meta=>{:title => "test", :stuff => "stuff"}}
+      @model = Struct.new(:formatted_title, :stuff).new("test", "stuff")
+
+      module Stuff
+        def stuff
+          "stuff"
+        end
+      end
+
+      class Dummy
+        include Simplifyapi::Representer
+
+        property :title do
+          get do |model|
+            model.formatted_title
+          end
+
+          set do |model, value|
+            model.formatted_title = value
+          end
+        end
+
+        representation do |json|
+          extend Stuff
+
+          json.meta do |meta|
+            meta.property :title
+            meta.stuff stuff
+          end
+        end
+      end
+    end
+
+    it "should call stuff" do
+      Dummy.new(@model).to_json.should include("stuff")
+    end
+  end
+
+  describe "Nested collections" do
+    before :each do
+      class Dummy
+        include Simplifyapi::Representer
+
+        property :title do
+          get do |model|
+            model.formatted_title
+          end
+
+          set do |model, value|
+            model.formatted_title = value
+          end
+        end
+
+        representation do |json|
+          json.meta do |meta|
+            meta.property :title
+          end
+        end
+      end
+
+      class NestedDummies
+        include Simplifyapi::Representer
+
+        collection :users, Dummy do
+          get { |model| model.dummies }
+        end
+
+        representation do |json|
+          json.meta do |meta|
+            meta.page 0
+            meta.total_pages 4
+          end
+
+          json.collection :users
+        end
+      end
+
+      @a = {:meta=>{:title => "test"}}
+      @b = {:meta=>{:title => "test2"}}
+
+      @collection_klass = Struct.new(:dummies)
+      @model_klass = Struct.new(:formatted_title)
+      @collection = @collection_klass.new [@model_klass.new("test"), @model_klass.new("test2")]
+
+      @hash = {
+        :meta => {
+        :page => 0,
+        :total_pages => 4
+      },
+        :users => [@a, @b]
+      }
+    end
+
+    it "should export the collection" do
+      NestedDummies.new(@collection).to_json.should ==(@hash.to_json)
+    end
+  end
+
+  describe "Standalone collections" do
+    before :each do
+      class Dummy
+        include Simplifyapi::Representer
+
+        property :title do
+          get do |model|
+            model.formatted_title
+          end
+
+          set do |model, value|
+            model.formatted_title = value
+          end
+        end
+
+        representation do |json|
+          json.meta do |meta|
+            meta.property :title
+          end
+        end
+      end
+
+      class DummyCollection
+        include Simplifyapi::CollectionRepresenter
+
+        representer Dummy
+
+        representation do |json|
+          json.meta do |meta|
+            meta.page 0
+            meta.total_pages 4
+          end
+
+          json.collection :users
+        end
+      end
+
+      @a = {:meta=>{:title => "test"}}
+      @b = {:meta=>{:title => "test2"}}
+
+      @model_klass = Struct.new(:formatted_title)
+      @collection = [@model_klass.new("test"), @model_klass.new("test2")]
+
+      @hash = {
+        :meta => {
+        :page => 0,
+        :total_pages => 4
+      },
+        :users => [@a, @b]
+      }
+    end
+
+    it "should export the collection" do
+      DummyCollection.new(@collection).to_json.should ==(@hash.to_json)
+    end
+  end
+
+  describe "Issue" do
+    before :each do
+      @model_klass = Struct.new(:foo)
+      @another_klass = Struct.new(:bar)
+
+      class Dummy
+        include Simplifyapi::Representer
+
+        property :foo
+        representation do |json|
+          json.meta do |meta|
+            meta.property :foo
+          end
+        end
+      end
+
+      class Another
+        include Simplifyapi::Representer
+
+        property :bar
+        representation do |json|
+          json.meta do |meta|
+            meta.property :bar
+          end
+        end
+      end
+
+      class DummyCollection
+        include Simplifyapi::CollectionRepresenter
+
+        representer Dummy
+
+        representation do |json|
+          json.collection :dummies
+        end
+      end
+
+      class AnotherCollection
+        include Simplifyapi::CollectionRepresenter
+
+        representer Another
+
+        representation do |json|
+          json.collection :anothers
+        end
+      end
+    end
+
+    it "should not share representer" do
+      DummyCollection.new([@model_klass.new("test"), @model_klass.new("test2")]).to_json
+      AnotherCollection.new([@another_klass.new("another"), @another_klass.new("another2")]).to_json
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'simplifyapi'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: simplifyapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- JH. Chabran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '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: Export and import json from a definable format
+email:
+- jh@chabran.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/simplifyapi.rb
+- lib/simplifyapi/builder.rb
+- lib/simplifyapi/collection.rb
+- lib/simplifyapi/collection_representer.rb
+- lib/simplifyapi/dsl_methods.rb
+- lib/simplifyapi/importer.rb
+- lib/simplifyapi/property.rb
+- lib/simplifyapi/representation.rb
+- lib/simplifyapi/representer.rb
+- lib/simplifyapi/version.rb
+- simplifyapi.gemspec
+- spec/simplifyapi/representer_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.24
+signing_key: 
+specification_version: 3
+summary: Export and import json from a definable format
+test_files:
+- spec/simplifyapi/representer_spec.rb
+- spec/spec_helper.rb
+has_rdoc: