motion-resource 0.0.1

data/lib/motion-resource/find.rb

@@ -0,0 +1,67 @@
+module MotionResource
+  class Base
+    class << self
+      def find(id, params = {}, &block)
+        fetch_member(member_url.fill_url_params(params.merge(id: id)), &block)
+      end
+
+      def find_all(params = {}, &block)
+        fetch_collection(collection_url.fill_url_params(params), &block)
+      end
+      
+      def fetch_member(url, &block)
+        get(url) do |response, json|
+          if response.ok?
+            obj = instantiate(json)
+            request_block_call(block, obj, response)
+          else
+            request_block_call(block, nil, response)
+          end
+        end
+      end
+
+      def fetch_collection(url, &block)
+        get(url) do |response, json|
+          if response.ok?
+            objs = []
+            arr_rep = nil
+            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]
+              end
+            else
+              # the returned data was something else
+              # ie a string, number
+              request_block_call(block, nil, response)
+              return
+            end
+            arr_rep.each { |one_obj_hash|
+              objs << instantiate(one_obj_hash)
+            }
+            request_block_call(block, objs, response)
+          else
+            request_block_call(block, nil, response)
+          end
+        end
+      end
+    
+    private
+      def request_block_call(block, default_arg, extra_arg)
+        if block
+          if block.arity == 1
+            block.call default_arg
+          elsif block.arity == 2
+            block.call default_arg, extra_arg
+          else
+            raise "Not enough arguments to block"
+          end
+        else
+          raise "No block given"
+        end
+      end
+    end
+  end
+end

data/lib/motion-resource/requests.rb

@@ -0,0 +1,64 @@
+module MotionResource
+  class Base
+    HTTP_METHODS = [:get, :post, :put, :delete]
+
+    HTTP_METHODS.each do |method|
+      define_method method do |*args, &block|
+        self.class.send(method, *args, &block)
+      end
+    end
+    
+    class << self
+      def get(url, params = {}, &block)
+        http_call(:get, url, params, &block)
+      end
+
+      def post(url, params = {}, &block)
+        http_call(:post, url, params, &block)
+      end
+
+      def put(url, params = {}, &block)
+        http_call(:put, url, params, &block)
+      end
+
+      def delete(url, params = {}, &block)
+        http_call(:delete, url, params, &block)
+      end
+
+    private
+      def complete_url(fragment)
+        if fragment[0..3] == "http"
+          return fragment
+        end
+        (self.root_url || MotionResource::Base.root_url) + fragment
+      end
+
+      def http_call(method, url, call_options = {}, &block)
+        options = call_options 
+        options.merge!(MotionResource::Base.default_url_options || {})
+        url += self.extension
+        if query = options.delete(:query)
+          if url.index("?").nil?
+            url += "?"
+          end
+          url += query.map{|k,v| "#{k}=#{v}"}.join('&')
+        end
+        if self.default_url_options
+          options.merge!(self.default_url_options)
+        end
+        BubbleWrap::HTTP.send(method, complete_url(url), options) do |response|
+          if response.ok?
+            body = response.body.to_str.strip rescue nil
+            if body.blank?
+              block.call(response, {})
+            else
+              block.call response, BubbleWrap::JSON.parse(body)
+            end
+          else
+            block.call response, nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/motion-resource/string.rb

@@ -0,0 +1,23 @@
+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 '/'
+    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[path_sym] || path).to_s
+      end
+
+      ret
+    }.join '/'
+  end
+end

data/lib/motion-resource/urls.rb

@@ -0,0 +1,29 @@
+module MotionResource
+  class Base
+    class_inheritable_accessor :collection_url, :member_url
+    class_inheritable_accessor :root_url, :default_url_options
+    class_inheritable_accessor :extension
+    self.extension = '.json'
+    
+    class << self
+      def custom_urls(params = {})
+        params.each do |name, url_format|
+          define_method name do |params = {}|
+            url_format.fill_url_params(params, self)
+          end
+          define_singleton_method name do
+            url_format
+          end
+        end
+      end
+    end
+
+    def collection_url(params = {})
+      self.class.collection_url.fill_url_params(params, self)
+    end
+
+    def member_url(params = {})
+      self.class.member_url.fill_url_params(params, self)
+    end
+  end
+end

data/lib/motion-resource/version.rb

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

data/motion-resource.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/motion-resource/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "motion-resource"
+  s.version     = MotionResource::VERSION
+  s.authors     = ["Thomas Kadauke"]
+  s.email       = ["thomas.kadauke@googlemail.com"]
+  s.homepage    = "https://github.com/tkadauke/motion-resource"
+  s.summary     = "Access RESTful resources from your iOS app"
+  s.description = "Access RESTful resources from your iOS app. Inspired by ActiveResource."
+
+  s.files         = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'bubble-wrap'
+  s.add_dependency 'motion-support'
+  s.add_development_dependency 'rake'
+end

data/spec/env.rb

@@ -0,0 +1,41 @@
+MotionResource::Base.root_url = 'http://example.com/'
+
+class Post < MotionResource::Base
+  attr_accessor :text
+  
+  self.member_url = 'posts/:id'
+  
+  has_many :comments
+end
+
+class Comment < MotionResource::Base
+  attr_accessor :post_id, :text
+  
+  self.member_url = 'comments/:id'
+  self.collection_url = 'comments'
+  
+  belongs_to :post
+  
+  scope :recent, :url => 'comments/recent'
+  
+  custom_urls :by_user_url => 'comments/by_user/:name'
+end
+
+class User < MotionResource::Base
+  self.member_url = 'users/:id'
+  
+  has_one :profile
+end
+
+class Profile < MotionResource::Base
+  attr_accessor :name, :email
+end
+
+class Shape < MotionResource::Base
+  attribute :contents, :position
+  attr_accessor :created_at
+end
+
+class Rectangle < Shape
+  attribute :size
+end

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

@@ -0,0 +1,116 @@
+describe "belongs_to" do
+  extend WebStub::SpecHelpers
+  
+  it "should define reader" do
+    Comment.new.should.respond_to :post
+  end
+  
+  it "should define writer" do
+    Comment.new.should.respond_to :post=
+  end
+  
+  it "should define reset method" do
+    Comment.new.should.respond_to :reset_post
+  end
+  
+  it "should reset" do
+    comment = Comment.new
+    comment.post = Post.new
+    comment.reset_post
+    comment.post.should.be.nil
+  end
+  
+  describe "reader" do
+    extend WebStub::SpecHelpers
+    
+    before do
+      stub_request(:get, "http://example.com/posts/1.json").to_return(json: { id: 1, text: 'Hello' })
+    end
+    
+    it "should by default return nil when called without a block" do
+      Comment.new.post.should.be.nil
+    end
+    
+    it "should return any cached values when called without a block" do
+      comment = Comment.new
+      post = Post.new
+      comment.post = post
+      comment.post.should == post
+    end
+    
+    it "should fetch resource when called with a block" do
+      @comment = Comment.new(:post_id => 1)
+      @comment.post do |result|
+        @result = result
+        resume
+      end
+      
+      wait_max 1.0 do
+        @result.text.should == 'Hello'
+      end
+    end
+    
+    it "should return cached resource immediately if exist when called with a block" do
+      post = Post.new
+      @comment = Comment.new
+      @comment.post = post
+      @comment.post do |result|
+        result.should == post
+      end
+    end
+    
+    it "should cache resource after fetching" do
+      @comment = Comment.new(:post_id => 1)
+      @comment.post do |result|
+        @result = result
+        resume
+      end
+      
+      wait_max 1.0 do
+        @comment.post.should == @result
+      end
+    end
+  end
+  
+  describe "writer" do
+    it "should create model when assigned with hash" do
+      comment = Comment.new
+      comment.post = { :id => 1, :text => 'Hello' }
+      comment.post.should.is_a Post
+    end
+    
+    it "should set attributes when assigned with hash" do
+      comment = Comment.new
+      comment.post = { :id => 1, :text => 'Hello' }
+      comment.post.text.should == 'Hello'
+    end
+    
+    it "should use identity map when assigned with hash" do
+      post = Post.instantiate(:id => 10)
+      comment = Comment.new
+      comment.post = { :id => 10 }
+      comment.post.should == post
+    end
+    
+    it "should act like a regular setter when assigned with object" do
+      post = Post.new
+      comment = Comment.new
+      comment.post = post
+      comment.post.should == post
+    end
+  end
+  
+  describe "piggybacking" do
+    it "should set association when returned with model" do
+      stub_request(:get, "http://example.com/comments/1.json").to_return(json: { id: 1, post: { id: 2, text: 'Hello' } })
+      Comment.find(1) do |result|
+        @result = result
+        resume
+      end
+      
+      wait_max 1.0 do
+        @result.post.text.should == 'Hello'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,128 @@
+describe "has_many" do
+  extend WebStub::SpecHelpers
+  
+  it "should define reader" do
+    Post.new.should.respond_to :comments
+  end
+  
+  it "should define writer" do
+    Post.new.should.respond_to :comments=
+  end
+  
+  it "should define reset method" do
+    Post.new.should.respond_to :reset_comments
+  end
+  
+  it "should reset" do
+    post = Post.new
+    post.comments = [Comment.new]
+    post.reset_comments
+    post.comments.should == []
+  end
+  
+  describe "reader" do
+    extend WebStub::SpecHelpers
+    
+    before do
+      stub_request(:get, "http://example.com/comments.json").to_return(json: [{ id: 1, text: 'Whats up?' }])
+    end
+    
+    it "should by default return an empty array when called without a block" do
+      Post.new.comments.should == []
+    end
+    
+    it "should return any cached values when called without a block" do
+      comment = Comment.new
+      post = Post.new
+      post.comments = [comment]
+      post.comments.should == [comment]
+    end
+    
+    it "should fetch resources when called with a block" do
+      @post = Post.new
+      @post.comments do |results|
+        @results = results
+        resume
+      end
+      
+      wait_max 1.0 do
+        @results.size.should == 1
+        @results.first.text.should == 'Whats up?'
+      end
+    end
+    
+    it "should return cached resources immediately if exist when called with a block" do
+      comment = Comment.new
+      @post = Post.new
+      @post.comments = [comment]
+      @post.comments do |results|
+        results.should == [comment]
+      end
+    end
+    
+    it "should assign backward associations when fetching resources" do
+      @post = Post.new
+      @post.comments do |results|
+        @results = results
+        resume
+      end
+      
+      wait_max 1.0 do
+        @results.first.post.should == @post
+      end
+    end
+    
+    it "should cache resources after fetching" do
+      @post = Post.new
+      @post.comments do |results|
+        @results = results
+        resume
+      end
+      
+      wait_max 1.0 do
+        @post.comments.should == @results
+      end
+    end
+  end
+  
+  describe "writer" do
+    it "should create model when assigned with hash" do
+      post = Post.new
+      post.comments = [{ :id => 1, :text => 'Whats up?' }]
+      post.comments.first.should.is_a Comment
+    end
+    
+    it "should set attributes when assigned with hash" do
+      post = Post.new
+      post.comments = [{ :id => 1, :text => 'Whats up?' }]
+      post.comments.first.text.should == 'Whats up?'
+    end
+    
+    it "should use identity map when assigned with hash" do
+      comment = Comment.instantiate(:id => 10)
+      post = Post.new
+      post.comments = [{ :id => 10 }]
+      post.comments.first.should == comment
+    end
+    
+    it "should act like a regular setter when assigned with array" do
+      post = Post.new
+      post.comments = [Comment.new]
+      post.comments.size.should == 1
+    end
+  end
+  
+  describe "piggybacking" do
+    it "should set association when returned with model" do
+      stub_request(:get, "http://example.com/posts/1.json").to_return(json: { id: 1, comments: [{ id: 2, text: 'Whats up?' }] })
+      Post.find(1) do |result|
+        @result = result
+        resume
+      end
+      
+      wait_max 1.0 do
+        @result.comments.first.text.should == 'Whats up?'
+      end
+    end
+  end
+end