motion-resource 0.1.3 → 0.1.4

data/README.md

@@ -2,6 +2,8 @@
 
 This is a library for using JSON APIs in RubyMotion apps. It is based on [RemoteModel](https://github.com/clayallsopp/remote_model), however it is an almost complete rewrite. Also, it is inspired by ActiveResource.
 
+This gem needs RubyMotion version 2.3 or higher.
+
 ## Installation
 
 Add MotionResource to your Gemfile, like this:
@@ -43,6 +45,38 @@ Now, we can access a user's posts like that:
 
 Note that the blocks are called asynchronously.
 
+## URL encoding
+
+A different url encoding implementation can be substituted by setting MotionResource::Base.url_encoder.
+For instance to include the fixed parameter 'foo' on every request:
+
+    class CustomEncoder < MotionResource::UrlEncoder
+        def build_query_string(url, params = {})
+            params[:foo] => 42
+            super(url,params)
+        end
+    end
+    MotionResource::Base.url_encoder = CustomEncoder.new
+
+## Error Handling
+
+Pass a second block parameter to capture error information:
+
+    User.find_all do |users, response|
+      if response.ok?
+        puts users.inspect
+      else
+        App.alert response.error_message
+      end
+    end
+
+`response` will be an instance of [BubbleWrap::HTTP::Response](http://rdoc.info/github/rubymotion/BubbleWrap/master/file/README.md#HTTP)
+
+## Reachability
+
+It's important to check the reachability status of a host before making a request, or you may get intermitent connectivity errors.
+For an example of how to do so, see `when_reachable` in [TinyMon](https://github.com/tkadauke/TinyMon).
+
 ## Setup
 
 You can configure every model separately; however you will most likely want to configure things like the root_url the same for every model:
@@ -54,3 +88,4 @@ Don't forget the trailing '/' here!
 # Forking
 
 Feel free to fork and submit pull requests!
+

data/Rakefile

@@ -1,6 +1,6 @@
 #!/usr/bin/env rake
 $:.unshift("/Library/RubyMotion/lib")
-require 'motion/project'
+require 'motion/project/template/ios'
 require "bundler/gem_tasks"
 Bundler.setup
 Bundler.require

data/lib/motion-resource/associations.rb

@@ -28,7 +28,7 @@ module MotionResource
         
         define_method name do |&block|
           if block.nil?
-            instance_variable_get("@#{name}") || []
+            instance_variable_get("@#{name}") || instance_variable_set("@#{name}", [])
           else
             if cached = instance_variable_get("@#{name}")
               cached_response = instance_variable_get("@#{name}_response")
@@ -67,7 +67,12 @@ module MotionResource
         end
       end
 
-      def belongs_to(name, params = lambda { |o| Hash.new })
+      def belongs_to(name, options = {})
+        default_options = {
+          :params => lambda { |o| Hash.new },
+          :class_name => name.to_s.classify
+        }
+        options = default_options.merge(options)
         define_method name do |&block|
           if block.nil?
             instance_variable_get("@#{name}")
@@ -77,8 +82,8 @@ module MotionResource
               MotionResource::Base.request_block_call(block, cached, cached_response)
               return
             end
-            
-            Object.const_get(name.to_s.classify).find(self.send("#{name}_id"), params.call(self)) do |result, response|
+            klass = Object.const_get(options[:class_name])
+            klass.find(self.send("#{name}_id"), options[:params].call(self)) do |result, response|
               instance_variable_set("@#{name}", result)
               instance_variable_set("@#{name}_response", response)
               MotionResource::Base.request_block_call(block, result, response)
@@ -87,8 +92,8 @@ module MotionResource
         end
         
         define_method "#{name}=" do |value|
-          klass = Object.const_get(name.to_s.classify)
-          value = klass.instantiate(value) if value.is_a?(Hash)
+          value = Object.const_get(options[:class_name]).instantiate(value) if value.is_a?(Hash)
+          instance_variable_set("@#{name}_id", value.id) if value.respond_to?(:id)
           instance_variable_set("@#{name}", value)
         end
         

data/lib/motion-resource/base.rb

@@ -18,7 +18,12 @@ module MotionResource
     
     class << self
       def instantiate(json)
-        json = json.symbolize_keys
+        if json.is_a?(Hash)
+          json = json.symbolize_keys
+        else
+          json = { primary_key => json.to_i }
+        end
+        
         raise ArgumentError, "No :#{primary_key} parameter given for #{self.name}.instantiate" unless json[primary_key]
         
         klass = if json[:type]
@@ -41,6 +46,10 @@ module MotionResource
         result
       end
       
+      def json_root
+        self.name.underscore.pluralize
+      end
+
       def identity_map
         @identity_map ||= {}
       end

data/lib/motion-resource/crud.rb

@@ -1,24 +1,22 @@
 module MotionResource
   class Base
-    def save(&block)
+    def save(options = {}, &block)
       run_callbacks :save do
-        @new_record ? create(&block) : update(&block)
+        @new_record ? create(options, &block) : update(options, &block)
       end
     end
     
-    def update(&block)
+    def update(options = {}, &block)
       run_callbacks :update do
-        self.class.put(member_url, :payload => { self.class.name.underscore => attributes }) do |response, json|
+        self.class.put(member_url, :payload => build_payload(options)) do |response, json|
           self.class.request_block_call(block, json.blank? ? self : self.class.instantiate(json), response) if block
         end
       end
     end
   
-    def create(&block)
-      # weird heisenbug: Specs crash without that line :(
-      dummy = self
+    def create(options = {}, &block)
       run_callbacks :create do
-        self.class.post(collection_url, :payload => { self.class.name.underscore => attributes }) do |response, json|
+        self.class.post(collection_url, :payload => build_payload(options)) do |response, json|
           self.class.request_block_call(block, json.blank? ? self : self.class.instantiate(json), response) if block
         end
       end
@@ -43,5 +41,26 @@ module MotionResource
         self.class.request_block_call(block, json.blank? ? nil : self.class.instantiate(json), response) if block
       end
     end
+    
+  protected
+    def build_payload(options)
+      includes = Array(options[:include]).inject({}) do |hash, var|
+        if var.to_s =~ /^(.*?)_attributes$/
+          association_name = $1
+        else
+          association_name = var.to_s
+        end
+        
+        if respond_to?(association_name)
+          hash[var.to_s] = send(association_name).map(&:attributes)
+        else
+          raise ArgumentError, "No association #{var} found"
+        end
+        
+        hash
+      end
+      
+      { self.class.name.underscore => attributes.merge(includes) }
+    end
   end
 end

data/lib/motion-resource/find.rb

@@ -2,11 +2,11 @@ module MotionResource
   class Base
     class << self
       def find(id, params = {}, &block)
-        fetch_member(member_url_or_default.fill_url_params(params.merge(id: id)), &block)
+        fetch_member(self.url_encoder.fill_url_params(member_url_or_default, params.merge(id: id)), &block)
       end
 
       def find_all(params = {}, &block)
-        fetch_collection(collection_url_or_default.fill_url_params(params), &block)
+        fetch_collection(self.url_encoder.fill_url_params(collection_url_or_default, params), &block)
       end
       
       def fetch_member(url, &block)
@@ -28,9 +28,9 @@ module MotionResource
             if json.class == Array
               arr_rep = json
             elsif json.class == Hash
-              plural = self.name.underscore.pluralize
-              if json.has_key?(plural) || json.has_key?(plural.to_sym)
-                arr_rep = json[plural] || json[plural.to_sym]
+              root = self.json_root
+              if json.has_key?(root) || json.has_key?(root.to_sym)
+                arr_rep = json[root] || json[root.to_sym]
               end
             else
               # the returned data was something else
@@ -38,9 +38,11 @@ module MotionResource
               request_block_call(block, nil, response)
               return
             end
-            arr_rep.each { |one_obj_hash|
-              objs << instantiate(one_obj_hash)
-            }
+            if arr_rep
+              arr_rep.each { |one_obj_hash|
+                objs << instantiate(one_obj_hash)
+              }
+            end
             request_block_call(block, objs, response)
           else
             request_block_call(block, nil, response)
@@ -63,4 +65,4 @@ module MotionResource
       end
     end
   end
-end
+end

data/lib/motion-resource/requests.rb

@@ -29,7 +29,27 @@ module MotionResource
         @on_auth_failure = block
       end
 
-    private
+      protected
+
+      def decode_response(response, url, options)
+        if response.ok?
+          body = response.body.to_str.strip rescue nil
+          logger.log "response: #{body}"
+          if body.blank?
+            return {}
+          else
+            return BubbleWrap::JSON.parse(body)
+          end
+        else
+          if response.status_code.to_s =~ /401/ && @on_auth_failure
+            @on_auth_failure.call
+          end
+          return nil
+        end
+      end
+
+      private
+
       def complete_url(fragment)
         if fragment[0..3] == "http"
           return fragment
@@ -43,30 +63,19 @@ module MotionResource
         options = call_options
         options.merge!(MotionResource::Base.default_url_options || {})
         if query = options.delete(:query)
-          url.build_query_string!(query)
+          url = self.url_encoder.build_query_string(url, query)
         end
         if self.default_url_options
           options.merge!(self.default_url_options)
         end
 
-        url.insert_extension!(self.extension)
+        url = self.url_encoder.insert_extension(url, self.extension)
 
         logger.log "#{method.upcase} #{url}"
+        logger.log "payload: #{options[:payload]}" if options[:payload]
 
         BubbleWrap::HTTP.send(method, url, options) do |response|
-          if response.ok?
-            body = response.body.to_str.strip rescue nil
-            logger.log "response: #{body}"
-            if body.blank?
-              block.call(response, {})
-            else
-              block.call response, BubbleWrap::JSON.parse(body)
-            end
-          elsif response.status_code.to_s =~ /401/ && @on_auth_failure
-            @on_auth_failure.call
-          else
-            block.call response, nil
-          end
+          block.call response, decode_response(response, url, options)
         end
       end
     end

data/lib/motion-resource/url_encoder.rb

@@ -0,0 +1,45 @@
+module MotionResource
+  class UrlEncoder
+    def fill_url_params(url, params = {}, delegate = nil)
+      params ||= {}
+      url = url.split('/').collect { |path|
+        ret = path
+        if path[0] == ':'
+          path_sym = path[1..-1].to_sym
+
+          curr = nil
+          if delegate && delegate.respond_to?(path_sym)
+            curr = delegate.send(path_sym)
+          end
+
+          ret = (curr || params.delete(path_sym) || path).to_s
+        end
+
+        ret
+      }.join '/'
+      self.build_query_string(url, params)
+    end
+
+    def build_query_string(url, params = {})
+      return url if params.keys.empty?
+      # fake a url so we avoid regex nastiness with URL's
+      url = NSURL.URLWithString("http://blah.com/#{url}")
+      # build our query string (needs encoding support!)
+      query_string = params.to_query
+      if url.query.nil? || url.query.empty?
+        # strip the beginning / and add the query
+        "#{url.path[1..-1]}?#{query_string}"
+      else
+        "#{url.path[1..-1]}?#{url.query}&#{query_string}"
+      end
+    end
+
+    def insert_extension(url,extension)
+      return url if extension.blank?
+
+      url = NSURL.URLWithString(url)
+      extension = extension.gsub(".", "")
+      url.URLByAppendingPathExtension(extension).absoluteString
+    end
+  end
+end

data/lib/motion-resource/urls.rb

@@ -3,13 +3,16 @@ module MotionResource
     class_attribute :collection_url, :member_url
     class_attribute :root_url, :default_url_options
     class_attribute :extension
+    class_attribute :url_encoder
+
     self.extension = '.json'
-    
+    self.url_encoder = UrlEncoder.new
+
     class << self
       def custom_urls(params = {})
         params.each do |name, url_format|
-          define_method name do |params = {}|
-            url_format.fill_url_params(params, self)
+          define_method name do |method_params = {}|
+            self.url_encoder.fill_url_params(url_format, method_params, self)
           end
           define_singleton_method name do
             url_format
@@ -24,14 +27,15 @@ module MotionResource
       def member_url_or_default
         member_url || "#{name.underscore.pluralize}/:#{primary_key}"
       end
+
     end
 
     def collection_url(params = {})
-      self.class.collection_url_or_default.fill_url_params(params, self)
+      self.class.url_encoder.fill_url_params(self.class.collection_url_or_default, params, self)
     end
 
     def member_url(params = {})
-      self.class.member_url_or_default.fill_url_params(params, self)
+      self.class.url_encoder.fill_url_params(self.class.member_url_or_default, params, self)
     end
   end
 end

data/lib/motion-resource/version.rb

@@ -1,3 +1,3 @@
 module MotionResource
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/env.rb

@@ -10,18 +10,23 @@ class Post < MotionResource::Base
 end
 
 class Comment < MotionResource::Base
-  attr_accessor :post_id, :text
+  attr_accessor :post_id, :account_id, :text
   
   self.member_url = 'comments/:id'
   self.collection_url = 'comments'
   
   belongs_to :post
-  
+  belongs_to :account, :class_name => 'User'
   scope :recent, :url => 'comments/recent'
-  
   custom_urls :by_user_url => 'comments/by_user/:name'
 end
 
+class CustomRootComment < Comment
+  def self.json_root
+    'custom'
+  end
+end
+
 class User < MotionResource::Base
   self.member_url = 'users/:id'
   

data/spec/motion-resource/associations/belongs_to_spec.rb

@@ -91,6 +91,21 @@ describe "belongs_to" do
         @response.should.be.ok
       end
     end
+
+    it "should return correct type of object" do
+      stub_request(:get, "http://example.com/users/1.json").to_return(json: { id: 1, text: 'Hello' })
+      @comment = Comment.new(:account_id => 1)
+      @comment.account do |results, response|
+        @account = results
+        @response = response
+        resume
+      end
+      wait_max 1.0 do
+        @response.should.be.ok
+        @account.class.should == User
+      end
+    end
+
   end
   
   describe "writer" do
@@ -99,11 +114,18 @@ describe "belongs_to" do
       comment.post = { :id => 1, :text => 'Hello' }
       comment.post.should.is_a Post
     end
+
+    it "should convert hash to proper type" do
+      comment = Comment.new
+      comment.account = { :id => 1, :text => 'Hello' }
+      comment.account.class.should == User
+    end
     
     it "should set attributes when assigned with hash" do
       comment = Comment.new
       comment.post = { :id => 1, :text => 'Hello' }
       comment.post.text.should == 'Hello'
+      comment.post.class.should == Post
     end
     
     it "should use identity map when assigned with hash" do
@@ -119,6 +141,18 @@ describe "belongs_to" do
       comment.post = post
       comment.post.should == post
     end
+    
+    it "should set association id when assigned with hash" do
+      comment = Comment.new
+      comment.post = { :id => 10 }
+      comment.post_id.should == 10
+    end
+    
+    it "should set association id when assigned with object" do
+      comment = Comment.new
+      comment.post = Post.new(:id => 10)
+      comment.post_id.should == 10
+    end
   end
   
   describe "piggybacking" do

data/spec/motion-resource/base_spec.rb

@@ -65,5 +65,15 @@ describe "base" do
       shape1.should.be.identical_to shape2
       shape1.contents.should == 'something'
     end
+    
+    it "should instantiate with ID number" do
+      shape = Shape.instantiate(3)
+      shape.id.should == 3
+    end
+    
+    it "should instantiate with ID string" do
+      shape = Shape.instantiate("5")
+      shape.id.should == 5
+    end
   end
 end

data/spec/motion-resource/crud_spec.rb

@@ -65,6 +65,35 @@ describe "crud" do
         @response.should.not.be.ok
       end
     end
+    
+    it "should include association" do
+      stub_request(:post, "http://example.com/posts.json").to_return(body: "")
+      Post.new.create(:include => :comments) do |result, response|
+        @response = response
+        resume
+      end
+    
+      wait_max 1.0 do
+        @response.should.be.ok
+      end
+    end
+    
+    it "should include association with _attributes suffix" do
+      stub_request(:post, "http://example.com/posts.json").to_return(body: "")
+      Post.new.create(:include => :comments_attributes) do |result, response|
+        @response = response
+        resume
+      end
+    
+      wait_max 1.0 do
+        @response.should.be.ok
+      end
+    end
+    
+    it "should raise error when included association is not found" do
+      stub_request(:post, "http://example.com/posts.json").to_return(body: "")
+      lambda { Post.new.create(:include => :foobar) { |result, response| } }.should.raise(ArgumentError)
+    end
   end
   
   describe "update" do
@@ -131,6 +160,19 @@ describe "crud" do
         @response.should.not.be.ok
       end
     end
+    
+    
+    it "should include association" do
+      stub_request(:put, "http://example.com/posts/10.json").to_return(body: "")
+      Post.instantiate(:id => 10).update(:include => :comments) do |result, response|
+        @response = response
+        resume
+      end
+    
+      wait_max 1.0 do
+        @response.should.be.ok
+      end
+    end
   end
 
   describe "destroy" do

data/spec/motion-resource/find_spec.rb

@@ -76,6 +76,20 @@ describe "find" do
     end
   end
 
+  it "should allow hash JSON response with custom JSON root" do
+    stub_request(:get, "http://example.com/bar.json").to_return(json: { custom: [{ id: 10, text: '42' }] })
+    CustomRootComment.fetch_collection("bar") do |result|
+      @result = result
+      resume
+    end
+    
+    wait_max 1.0 do
+      @result.should.is_a Array
+      @result.first.should.is_a CustomRootComment
+      @result.first.text.should == '42'
+    end
+  end
+
   it "should give nil object if fetching collection fails" do
     stub_request(:get, "http://example.com/bar.json").to_return(status_code: 404)
     Comment.fetch_collection("bar") do |result|

data/spec/motion-resource/requests_spec.rb

@@ -120,7 +120,8 @@ describe "requests" do
   it "should call a block given to on_auth_failure on 401" do
     stub_request(:get, "http://example.com/comments/10.json").to_return(status_code: 401)
     @fail = false
-    Comment.on_auth_failure { @fail = true; resume }
+    Comment.on_auth_failure { @fail = true }
+
     Comment.new.get("comments/10") do |response, json|
       resume
     end

data/spec/motion-resource/{string_spec.rb → url_encoder_spec.rb}

@@ -2,34 +2,38 @@ class DelegateObject
   attr_accessor :id, :name
 end
 
-describe "String" do
+describe "url encoder" do
+  before do
+     @encoder = MotionResource::Base.url_encoder
+  end
+
   it "should fill url params from params hash" do
-    string = "accounts/:id/users/:name".fill_url_params(id: 10, name: 'john')
+    string = @encoder.fill_url_params("accounts/:id/users/:name", {id: 10, name: 'john'})
     string.should == "accounts/10/users/john"
   end
 
   it "should insert an extension if missing" do
-    string = "accounts/fabulous".insert_extension!(".json")
+    string = @encoder.insert_extension("accounts/fabulous",".json")
     string.should == "accounts/fabulous.json"
   end
 
   it "should not insert extension if it is blank" do
-    string = "accounts/fabulous".insert_extension!("")
+    string = @encoder.insert_extension("accounts/fabulous","")
     string.should == "accounts/fabulous"
   end
 
   it "should add a query string for non-url params" do
-    string = "accounts/fabulous".build_query_string!(foo: 10, moo: "rar")
+    string = @encoder.build_query_string("accounts/fabulous", {foo: 10, moo: "rar"})
     string.should == "accounts/fabulous?foo=10&moo=rar"
   end
 
   it "should not add a ? when building a query string if it exists" do
-    string = "accounts/fabulous?".build_query_string!(foo: 10, moo: "rar")
+    string = @encoder.build_query_string("accounts/fabulous?", {foo: 10, moo: "rar"})
     string.should == "accounts/fabulous?foo=10&moo=rar"
   end
 
   it "should tag new query params onto existing ones" do
-    string = "accounts/fabulous?moo=rar".build_query_string!(foo: 10)
+    string = @encoder.build_query_string("accounts/fabulous?moo=rar", {foo: 10})
     string.should == "accounts/fabulous?moo=rar&foo=10"
   end
 
@@ -37,15 +41,15 @@ describe "String" do
     obj = DelegateObject.new
     obj.id = 10
     obj.name = 'john'
-    string = "accounts/:id/users/:name".fill_url_params({}, obj)
+    string = @encoder.fill_url_params("accounts/:id/users/:name", {}, obj)
     string.should == "accounts/10/users/john"
   end
 
   it "should not crash when a param is unknown" do
-    lambda { "accounts/:id".fill_url_params({}) }.should.not.raise
+    lambda { @encoder.fill_url_params("accounts/:id", {}) }.should.not.raise
   end
 
   it "should not crash when params hash contains an unused value" do
-    lambda { "accounts".fill_url_params(foo: 'bar') }.should.not.raise
+    lambda { @encoder.fill_url_params("accounts", {foo:'bar'}) }.should.not.raise
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion-resource
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2013-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bubble-wrap
@@ -90,7 +90,7 @@ files:
 - lib/motion-resource/logger.rb
 - lib/motion-resource/requests.rb
 - lib/motion-resource/spec_helpers.rb
-- lib/motion-resource/string.rb
+- lib/motion-resource/url_encoder.rb
 - lib/motion-resource/urls.rb
 - lib/motion-resource/version.rb
 - motion-resource.gemspec
@@ -105,7 +105,7 @@ files:
 - spec/motion-resource/crud_spec.rb
 - spec/motion-resource/find_spec.rb
 - spec/motion-resource/requests_spec.rb
-- spec/motion-resource/string_spec.rb
+- spec/motion-resource/url_encoder_spec.rb
 - spec/motion-resource/urls_spec.rb
 homepage: https://github.com/tkadauke/motion-resource
 licenses: []
@@ -121,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3993476988303272926
+      hash: 3639631242463817566
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -130,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3993476988303272926
+      hash: 3639631242463817566
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -149,5 +149,5 @@ test_files:
 - spec/motion-resource/crud_spec.rb
 - spec/motion-resource/find_spec.rb
 - spec/motion-resource/requests_spec.rb
-- spec/motion-resource/string_spec.rb
+- spec/motion-resource/url_encoder_spec.rb
 - spec/motion-resource/urls_spec.rb

data/lib/motion-resource/string.rb

@@ -1,46 +0,0 @@
-class String
-  # Takes in a hash and spits out the formatted string
-  # Checks the delegate first
-  def fill_url_params(params = {}, delegate = nil)
-    params ||= {}
-    split = self.split '/'
-    url = split.collect { |path|
-      ret = path
-      if path[0] == ':'
-        path_sym = path[1..-1].to_sym
-
-        curr = nil
-        if delegate && delegate.respond_to?(path_sym)
-          curr = delegate.send(path_sym)
-        end
-
-        ret = (curr || params.delete(path_sym) || path).to_s
-      end
-
-      ret
-    }.join '/'
-    url.build_query_string! params
-  end
-
-  def build_query_string!(params = {})
-    return self if params.keys.empty?
-    # fake a url so we avoid regex nastiness with URL's
-    url = NSURL.URLWithString("http://blah.com/#{self}")
-    # build our query string (needs encoding support!)
-    query_string = params.to_query
-    if url.query.nil? || url.query.empty?
-      # strip the beginning / and add the query
-      self.replace "#{url.path[1..-1]}?#{query_string}"
-    else
-      self.replace "#{url.path[1..-1]}?#{url.query}&#{query_string}"
-    end
-  end
-
-  def insert_extension!(extension)
-    return self if extension.blank?
-    
-    url = NSURL.URLWithString(self)
-    extension = extension.gsub(".", "")
-    self.replace url.URLByAppendingPathExtension(extension).absoluteString
-  end
-end