motion_model_resource 0.1.6

data/.gitignore

@@ -0,0 +1,11 @@
+.repl_history
+build
+resources/*.nib
+resources/*.momd
+resources/*.storyboardc
+.DS_Store
+doc/**/*.*
+doc
+*.gem
+
+.rvmrc

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "rake"
+gem 'motion_model'
+gem 'webstub'
+gem 'bubble-wrap'
+gem 'motion-support'

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bubble-wrap (1.3.0.osx)
+    motion-require (0.0.6)
+    motion-support (0.2.4)
+      motion-require (>= 0.0.6)
+    motion_model (0.4.4)
+      bubble-wrap (= 1.3.0.osx)
+      motion-support (>= 0.1.0)
+    rake (10.0.4)
+    webstub (0.3.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bubble-wrap
+  motion-support
+  motion_model
+  rake
+  webstub

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Torben Toepper
+
+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,152 @@
+MotionModelResource: Simple JSON API Wrapper for MotionModel on RubyMotion
+==========================================================================
+
+MotionModelResource is a simple wrapper to store your remote data in MotionModel objects. It is good for users who have a
+REST API and want to have it in an iOS app.
+
+You need to have MotionModel ready, if you want to use this implementation: https://github.com/sxross/MotionModel
+
+
+### Overview
+* [Installation](#installation)
+* [Setup](#setup)
+* [Usage](#usage)
+
+
+Installation
+------------
+Add the following line to your `Gemfile`:
+
+`gem "motion-model-resource"`
+
+You need to require the Gem. Insert the
+following immediately before `Motion::Project::App.setup`:
+
+```ruby
+require 'motion_model' # If you haven't already
+require 'motion_model_resource'
+```
+
+Then, update your bundle:
+
+`bundle`
+
+
+Setup
+-----
+
+First of all you will need a normal MotionModel::Model:
+
+```ruby
+class Task
+  include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
+
+  columns name:         :string,
+          long_name:    :string,
+          due_date:     :date,
+          lastSyncedAt: :time
+end
+```
+
+Tune this up, by adding:
+```ruby
+...
+  include MotionModelResource::ApiWrapper
+
+  def self.url
+    "https://example.com/tasks"
+  end
+
+  def self.wrapper
+    @wrapper ||= {
+      fields: {
+        id:         :id,
+        name:       :name,
+        long_name:  :long_name,
+        due_date:   :due_date
+      },
+      relations: [:user]
+    }
+  end
+...
+```
+The wrapper hash has two main keys. The first one is "fields". Here you specify the local and remote keys, you want to have from your API response. The hash-key is the remote key and the hash-value is the local key. It is used, if you have different names in your implementation (maybe camelcase with underscore).
+The second key in the main hash is the "relations" part. Here you can specify the wanted relations from your remote response. It will automatacally look after the right relation, for example if you have a relation "tasks", and the response is an array, it will create a bunch of tasks for you.
+
+The url method will be used for saving a remote model. Maybe in future for a routes prefix.
+
+
+Usage
+-----
+
+### Getting Remote Models
+
+Fetching your API by calling "fetch" on your model class:
+
+```ruby
+Task.fetch("https://example.com/tasks")
+```
+
+**Example Response**
+```javascript
+[{
+  "id": 1,
+  "name": 'Buy beer',
+  "long_name": 'Many, many, many beer!',
+  "due_date": "2013-11-03T20:40:00+01:00",
+  "updated_at": "2013-11-03T20:20:10+01:00",
+  "created_at": "2013-11-03T20:06:01+01:00"
+},{
+  "id": 2,
+  "name": 'Drink beer',
+  "long_name": 'Beer, beer, beer, beer',
+  "due_date": "2013-11-03T21:40:00+01:00",
+  "updated_at": "2013-11-03T20:20:10+01:00",
+  "created_at": "2013-11-03T20266:01+01:00"
+}]
+```
+
+After this call, you will have a bunch of records in your collection.
+If you want to have a direct callback, after the new records have stored, you can call the method with a block:
+
+```ruby
+Task.fetch("https://example.com/tasks") do |tasks|
+  tasks.each do |task|
+    puts task.name
+  end
+end
+```
+
+If you need specific URL parameters, you can add them as the second parameter:
+```ruby
+Task.fetch("https://example.com/tasks", {api_key: "top_secret!"})
+```
+
+If you want to update an existing record, you can use the instance method fetch.
+```ruby
+task = Task.first
+task.fetch("https://example.com/tasks")
+```
+
+**Tip:** If you have the lastSyncedAt column in your model, this will automatacally set to the current timestamp!
+
+
+### Saving Remote Models
+
+If you want to store your local model, you can simply do this with MotionModelResource. You just need to configure an url class method and giving a block for the save method:
+
+```ruby
+task = Task.first
+task.name = "Drinking a lot of soda"
+task.save do |model|
+  if model.present?
+    puts "task saved!"
+  else
+    puts "Damn, something went wrong..."
+  end
+end
+```
+
+The task object will update, too. As you can see, if the model var is nil, the save process had failed.
+The save method will store the relations too!! It will serialize the whole model and push this to the server. The mapping information comes also from the wrapper method.

data/Rakefile

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require "bundler/gem_tasks"
+$:.unshift("/Library/RubyMotion/lib")
+require 'motion/project/template/ios'
+require 'bundler'
+Bundler.require
+
+$:.unshift(File.expand_path('../lib', __FILE__))
+require 'motion_model_resource'
+require 'bubble-wrap/core'
+require 'bubble-wrap/http'
+
+Motion::Project::App.setup do |app|
+  # Use `rake config' to see complete project settings.
+  app.name = 'MotionModelResource'
+  app.delegate_class = 'FakeDelegate'
+  app.files = (app.files + Dir.glob('./app/**/*.rb')).uniq
+end

data/app/app_delegate.rb

@@ -0,0 +1,2 @@
+class FakeDelegate
+end

data/lib/motion_model_resource.rb

@@ -0,0 +1,5 @@
+Motion::Project::App.setup do |app|
+  Dir.glob(File.join(File.expand_path('../../motion/**/*.rb', __FILE__))).each do |file|
+    app.files.unshift(file)
+  end
+end

data/motion/resource/data_parser.rb

@@ -0,0 +1,13 @@
+module MotionModelResource
+  module DateParser
+    def self.parseDate(arg)
+      date_formatter = NSDateFormatter.alloc.init
+      date_formatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ssZZZZ"
+      date = date_formatter.dateFromString arg
+
+      return nil if date.blank?
+
+      date.description
+    end
+  end
+end

data/motion/resource/wrapper.rb

@@ -0,0 +1,206 @@
+module MotionModelResource
+  class WrapperNotDefinedError < Exception; end
+  class URLNotDefinedError < Exception; end
+  class ActionNotImplemented < Exception; end
+
+  module ApiWrapper
+    def self.included(base)
+      base.extend(PublicClassMethods)
+    end
+
+    module PublicClassMethods
+      # Returns the last updated at or nil value of Model
+      def lastUpdate
+        order(:updated_at).first.try(:updated_at)
+      end
+
+      # Loads the given URL and parse the JSON for new models.
+      # If the models are present, the model will update.
+      # If block given, the block will called, when the the models are saved. The model/s will be passed as an argument to the block.
+      def fetch(site, params = {}, &block)
+        raise MotionModelResource::WrapperNotDefinedError.new "Wrapper is not defined!" unless self.respond_to?(:wrapper)
+        BW::HTTP.get(site, params) do |response|
+          models = []
+          if response.ok? && response.body.present?
+            json = BW::JSON.parse(response.body.to_str)
+            models = updateModels(json)
+          end
+
+          block.call(models) if block.present? && block.respond_to?(:call)
+        end
+      end
+
+      # Parses given JSON object and saves the founded models.
+      # Returns an array with models, or the founded model
+      def updateModels(json)
+        if json.is_a?(Array)
+          models = []
+          for jsonPart in json
+            model = buildModel(jsonPart)
+            if model.present?
+              model.save
+              models << model
+            end
+          end
+          return models
+        else
+          model = buildModel(json)
+          if model.present?
+            model.save
+            return model
+          end
+        end
+      end
+
+      # Builds a model for given JSON object. Returns a new or presend model.
+      def buildModel(json)
+        classname = name.downcase
+
+        model = where("id").eq(json["id"]).first
+        if model.present?
+          if model.wrap(json)
+            model.lastSyncAt = Time.now if model.respond_to?(:lastSyncAt)
+            return model
+          end
+        else
+          newModel = self.new
+          return newModel if newModel.wrap(json)
+        end
+
+        return nil
+      end
+    end
+
+    # Instance methods
+
+    # Saves the current model. Calls super when block is not given.
+    # If block is given, the url method will be needed to call the remote server.
+    # The answer of the server will be parsed and stored.
+    # If the record is a new one, a POST request will be fired, otherwise a PUT call comes to the server.
+    def save(options = {}, &block)
+      if block.present?
+        raise MotionModelResource::URLNotDefinedError.new "URL is not defined for #{self.class.name}!" unless self.class.respond_to?(:url)
+
+        action = if new_record?
+          "create"
+        elsif self.id.present?
+          "update"
+        else
+          raise MotionModelResource::ActionNotImplemented.new "Action ist not implemented for #{self.class.name}!"
+        end
+
+        model = self
+
+        model.id = nil if model.id.present? && action == "create"
+
+        hash = buildHashFromModel(self.class.name.downcase, self)
+        hash.merge!(options[:params]) if options[:params].present?
+
+        requestBlock = Proc.new do |response|
+          if response.ok? && response.body.present?
+            json = BW::JSON.parse(response.body.to_str)
+
+            model.wrap(json)
+            model.lastSyncAt = Time.now if model.respond_to?(:lastSyncAt)
+            model.save
+          else
+            model = nil
+          end
+
+          block.call(model) if block.present? && block.respond_to?(:call)
+        end
+
+        case action
+        when "create"
+          BW::HTTP.post(self.class.url, {payload: hash}, &requestBlock)
+        when "update"
+          BW::HTTP.put("#{self.class.url}/#{model.id}", {payload: hash}, &requestBlock)
+        end
+      else
+        super
+      end
+    end
+
+    # Returns a hash with given model
+    def buildHashFromModel(mainKey, model)
+      hash = {
+        mainKey => {}
+      }
+      hash[mainKey] = {}
+
+      model.attributes.each do |key, attribute|
+        if model.class.has_many_columns.keys.include?(key)
+          newKey = attribute.first.class.name.pluralize.downcase
+          hash[mainKey][newKey] = []
+          for a in attribute
+            hash[mainKey][newKey].push(buildHashFromModel(newKey, a)[newKey])
+          end
+        elsif attribute.respond_to?(:attributes)
+          newKey = attribute.class.name.downcase
+          h = buildHashFromModel(newKey, attribute)
+          hash[mainKey][newKey] = h[newKey] if h.has_key?(newKey)
+        else
+          model.class.wrapper[:fields].each do |wrapperKey, wrapperValue|
+            hash[mainKey][wrapperKey] = attribute if wrapperValue == key
+          end
+        end
+      end
+
+      return hash
+    end
+
+    # Loads the given URL and parse the JSON for a model.
+    # If the model is present, the model will updates.
+    # If block given, the block will called, when the the model is saved. The model will be passed as an argument to the block.
+    def fetch(site, params, &block)
+      raise MotionModelResource::WrapperNotDefinedError.new "Wrapper is not defined!" unless self.class.respond_to?(:wrapper)
+      model = self
+      BW::HTTP.get(site, params) do |response|
+        if response.ok? && response.body.present?
+          json = BW::JSON.parse(response.body.to_str)
+          model.wrap(json)
+          model.lastSyncAt = Time.now if model.respond_to?(:lastSyncAt)
+
+          model.save
+        end
+
+        block.call if block.present? && block.respond_to?(:call)
+      end
+    end
+
+    # Wraps the current model with the given JSON.
+    # All the fields found in JSON and self.wrapper will be parsed.
+    # Returns true, when no error exists
+    def wrap(modelJson)
+      return unless self.class.respond_to?(:wrapper)
+
+      self.class.wrapper[:fields].each do |online, local|
+        if modelJson.respond_to?("key?") && modelJson.key?("#{online}")
+          value = parseValue(local, modelJson[online])
+          self.send("#{local}=", value)
+        end
+      end
+
+      if self.class.wrapper[:relations].present?
+        self.class.wrapper[:relations].each do |relation|
+          if modelJson.respond_to?("key?") && modelJson.key?("#{relation}") && modelJson["#{relation}"].present?
+            klass = Object.const_get(relation.to_s.singularize.camelize)
+            newRelation = klass.updateModels(modelJson["#{relation}"])
+            self.send("#{relation}=", newRelation) rescue NoMethodError # not correct implemented in MotionModel
+          end
+        end
+      end
+
+      true
+    end
+
+    # Parses given value for key in the right format for MotionModel.
+    # Currently only Date/Time support needed
+    def parseValue(key, value)
+      case self.column_type(key.to_sym)
+      when :date, :time then MotionModelResource::DateParser.parseDate value
+      else value
+      end
+    end
+  end
+end

data/motion/version.rb

@@ -0,0 +1,3 @@
+module MotionModelResource
+  VERSION = "0.1.6"
+end

data/motion_model_resource.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../motion/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Torben Toepper"]
+  gem.email         = ["lshadyl@googlemail.com"]
+  gem.description   = "Simple JSON API Wrapper for MotionModel on RubyMotion"
+  gem.summary       = "Simple JSON API Wrapper for MotionModel on RubyMotion"
+  gem.homepage      = "https://github.com/torben/motion-resource"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "motion_model_resource"
+  gem.require_paths = ["lib"]
+  gem.add_dependency 'bubble-wrap', '>= 1.3.0'
+  gem.add_dependency 'motion-support', '>=0.1.0'
+  gem.add_dependency 'motion_model', '>=0.4.4'
+  gem.add_dependency 'webstub', '>=0.3.0'
+  gem.version       = MotionModelResource::VERSION
+  gem.licenses      = ["MIT"]
+end

data/spec/wrapper_spec.rb

@@ -0,0 +1,186 @@
+class UserWithOutWrapper
+  include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
+  include MotionModelResource::ApiWrapper
+  columns       name:   :string,
+                email:  :string,
+                age:    :integer,
+                admin:  :boolean
+end
+
+class User
+  include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
+  include MotionModelResource::ApiWrapper
+
+  def self.url
+    "http://example.com/users"
+  end
+
+  def self.wrapper
+    @wrapper ||= {
+      fields: {
+        id:       :id,
+        plan_id:  :plan_id,
+        name:     :name,
+        email:    :email,
+        age:      :age,
+        admin:    :admin
+      },
+      relations: [:tasks, :plan]
+    }
+  end
+
+  columns name:     :string,
+          plan_id:  :plan_id,
+          email:    :string,
+          age:      :integer,
+          admin:    :boolean
+
+  has_many :tasks
+  belongs_to :plan
+end
+
+class Task
+  include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
+  include MotionModelResource::ApiWrapper
+
+  def self.url
+    "http://example.com/tasks"
+  end
+
+  def self.wrapper
+    @wrapper ||= {
+      fields: {
+        id:       :id,
+        user_id:  :user_id,
+        name:     :name,
+      },
+      relations: [:user]
+    }
+  end
+
+  columns name: :string
+  belongs_to :user
+end
+
+class Plan
+  include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
+  include MotionModelResource::ApiWrapper
+
+  def self.url
+    "http://example.com/plans"
+  end
+
+  def self.wrapper
+    @wrapper ||= {
+      fields: {
+        id:       :id,
+        name:     :name,
+      },
+      relations: [:users]
+    }
+  end
+
+  columns name: :string
+  has_many :users
+end
+
+describe "Fetching a model" do
+  extend WebStub::SpecHelpers
+
+  it "should not wrap a model without wrapper method" do
+    lambda{
+      UserWithOutWrapper.fetch("http://localhost:3000/users/1")
+    }.should.raise(MotionModelResource::WrapperNotDefinedError)
+  end
+
+  it "should create a new model with API call" do
+    user_url = "http://localhost:3000/users/1"
+    stub_request(:get, user_url).to_return(json: {
+      name:  "Peter",
+      email: "peter@pan.de",
+      age:   14,
+      admin: false
+    })
+
+    User.fetch(user_url) do |model|
+      resume
+    end
+
+    wait_max 1.0 do
+      user = User.first
+      user.should.not == nil
+      User.count.should.equal(1)
+      user.name.should.equal("Peter")
+      user.email.should.equal("peter@pan.de")
+      user.age.should.equal(14)
+      user.admin.should.equal(false)
+    end
+  end
+
+  it "should create a new model with dependencies" do
+    User.delete_all
+    Task.delete_all
+    Plan.delete_all
+
+    user_url = "http://localhost:3000/users/10"
+    stub_request(:get, user_url).to_return(json: {
+      id: 10,
+      plan_id: 5,
+      name:  "Manuel",
+      email: "manuel@dudda.de",
+      age:   28,
+      admin: true,
+      tasks: [
+        {
+          id: 1,
+          name: 'Cleaning up the closet',
+          user_id: 10
+        },
+        {
+          id: 2,
+          name: 'Drinking soda',
+          user_id: 10
+        }
+      ],
+      plan: {
+        id: 5,
+        name: 'Gold'
+      }
+    })
+
+    User.fetch(user_url) do |model|
+      resume
+    end
+
+    wait_max 1.0 do
+      User.count.should.equal(1)
+      Plan.count.should.equal(1)
+      Task.count.should.equal(2)
+
+      user = User.find(10)
+      user.plan.name.should.equal("Gold")
+      user.tasks.first.name.should.equal("Cleaning up the closet")
+      user.tasks.last.name.should.equal("Drinking soda")
+    end
+  end
+
+  describe '#parseValue' do
+    it 'should parse a date in the right format for MotionModel' do
+      time_string = "2013-11-03T16:59:35+01:00"
+
+      MotionModelResource::DateParser.parseDate(time_string).should.equal("2013-11-03 15:59:35 +0000")
+    end
+
+    it 'should return nil, when giving a wrong time' do
+      time_string = "2342"
+      time_string2 = "2013-21-03T16:59:35+01:00"
+
+      MotionModelResource::DateParser.parseDate(time_string).should.equal nil
+      MotionModelResource::DateParser.parseDate(time_string2).should.equal nil
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: motion_model_resource
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+  prerelease: 
+platform: ruby
+authors:
+- Torben Toepper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bubble-wrap
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: motion-support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: motion_model
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+- !ruby/object:Gem::Dependency
+  name: webstub
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: Simple JSON API Wrapper for MotionModel on RubyMotion
+email:
+- lshadyl@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- app/app_delegate.rb
+- lib/motion_model_resource.rb
+- motion/resource/data_parser.rb
+- motion/resource/wrapper.rb
+- motion/version.rb
+- motion_model_resource.gemspec
+- spec/wrapper_spec.rb
+homepage: https://github.com/torben/motion-resource
+licenses:
+- MIT
+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: Simple JSON API Wrapper for MotionModel on RubyMotion
+test_files:
+- spec/wrapper_spec.rb