parse_resource 1.6.3 → 1.7.0

data/README.md

@@ -1,7 +1,7 @@
 ParseResource 
 =============
 
-ParseResource makes it easy to interact with Parse.com's REST API. It adheres to the ActiveRecord pattern. ParceResource is fully ActiveModel compliant, meaning you can use validations and Rails forms.
+ParseResource makes it easy to interact with Parse.com's REST API. It adheres to the ActiveRecord pattern. ParseResource is fully ActiveModel compliant, meaning you can use validations and Rails forms.
 
 Ruby/Rails developers should feel right at home.
 
@@ -26,7 +26,7 @@ Installation
 Include in your `Gemfile`:
 
 ```ruby
-gem "parse_resource", "~> 1.6.2"
+gem "parse_resource", "~> 1.6.3"
 ```
 
 Or just gem install:
@@ -138,6 +138,34 @@ posts.length #=> 5
 Post.where(:bar => "foo").count #=> 1337
 ```
 
+Associations
+
+```ruby
+class Post < ParseResource::Base
+  belongs_to :author
+  fields :title, :body
+end
+
+class Author < ParseResource::Base
+  has_many :posts
+  field :name
+end
+
+author = Author.create(:name => "RL Stine")
+post1 = Post.create(:title => "Goosebumps 1")
+post2 = Post.create(:title => "Goosebumps 2")
+
+# assign from parent class
+author.posts << post1
+author.posts << post2 
+
+# or assign from child class
+post3 = Post.create(:title => "Goosebumps 3")
+post3.author = author
+post3.save
+```
+
+
 Documentation
 -------------
 [Here](http://rubydoc.info/gems/parse_resource/)
@@ -146,7 +174,7 @@ To-do
 --------------
 *   User authentication
 *   Better documentation
-*   Associations
+*   ~~Associations~~
 *   Callbacks
 *   Push notifications
 *   Better type-casting

data/VERSION

@@ -1 +1 @@
-1.6.3
+1.7.0

data/lib/base.rb

@@ -6,8 +6,10 @@ require "rest-client"
 require "json"
 require "active_support/hash_with_indifferent_access"
 require "query"
+require "parse_error"
 
 module ParseResource
+  
 
   class Base
     # ParseResource::Base provides an easy way to use Ruby to interace with a Parse.com backend
@@ -24,14 +26,14 @@ module ParseResource
     HashWithIndifferentAccess = ActiveSupport::HashWithIndifferentAccess
 
     define_model_callbacks :save, :create, :update, :destroy
-
-
+    
     # Instantiates a ParseResource::Base object
     #
     # @params [Hash], [Boolean] a `Hash` of attributes and a `Boolean` that should be false only if the object already exists
     # @return [ParseResource::Base] an object that subclasses `Parseresource::Base`
     def initialize(attributes = {}, new=true)
-      attributes = HashWithIndifferentAccess.new(attributes)
+      #attributes = HashWithIndifferentAccess.new(attributes)
+      
       if new
         @unsaved_attributes = attributes
       else
@@ -66,37 +68,91 @@ module ParseResource
     def self.fields(*args)
       args.each {|f| field(f)}
     end
+    
+    def self.belongs_to(parent)
+      field(parent)
+    end
+  
+
+    def to_pointer
+      {"__type" => "Pointer", "className" => self.class.model_name, "objectId" => self.id}
+    end
 
     # Creates getter and setter methods for model fields
     # 
     def create_setters!
       @attributes.each_pair do |k,v|
+        
         self.class.send(:define_method, "#{k}=") do |val|
           if k.is_a?(Symbol)
             k = k.to_s
           end
+          
+          val = val.to_pointer if val.respond_to?(:to_pointer)
+
           @attributes[k.to_s] = val
           @unsaved_attributes[k.to_s] = val
+          
           val
         end
+        
         self.class.send(:define_method, "#{k}") do
-          if k.is_a?(Symbol)
-            k = k.to_s
+                  
+          case @attributes[k]
+          when Hash
+            
+            case @attributes[k]["__type"]
+            when "Pointer"
+              result = @attributes[k]["className"].constantize.find(@attributes[k]["objectId"])
+            end #todo: support Dates and other types https://www.parse.com/docs/rest#objects-types
+            
+          else
+            result =  @attributes[k]
           end
-
-          if @attributes[k.to_s].is_a?(Hash) && !@attributes[k.to_s]["__type"].nil?
-            case @attributes[k.to_s]["__type"]
-            when "Date"
-              return result = @attributes[k.to_s]["iso"]
-            end
-          end
-
-          return @attributes[k.to_s]
+          
+          result
         end
+        
       end
     end
 
     class << self
+      
+      def has_many(children)
+        parent_klass_name = model_name
+        lowercase_parent_klass_name = parent_klass_name.downcase
+        parent_klass = model_name.constantize
+        child_klass_name = children.to_s.singularize.camelize
+        child_klass = child_klass_name.constantize
+        
+        if parent_klass_name == "User"
+          parent_klass_name = "_User"
+        end
+        
+        @@parent_klass_name = parent_klass_name
+        #@@parent_instance = self
+        
+        send(:define_method, children) do
+          @@parent_id = self.id
+          @@parent_instance = self
+          
+          
+          singleton = child_klass.where(@@parent_klass_name.downcase => @@parent_instance.to_pointer).all
+
+          class << singleton
+            def <<(child)
+              if @@parent_instance.respond_to?(:to_pointer)
+                child.send("#{@@parent_klass_name.downcase}=", @@parent_instance.to_pointer)
+                child.save
+              end
+              super(child)
+            end
+          end
+                    
+          singleton
+        end
+        
+      end
 
       @@settings ||= nil
 
@@ -111,7 +167,8 @@ module ParseResource
       def settings
         if @@settings.nil?
           path = "config/parse_resource.yml"
-          environment = defined?(Rails) && Rails.respond_to?(:env) ? Rails.env : ENV["RACK_ENV"]
+          #environment = defined?(Rails) && Rails.respond_to?(:env) ? Rails.env : ENV["RACK_ENV"]
+          environment = ENV["RACK_ENV"]
           @@settings = YAML.load(ERB.new(File.new(path).read).result)[environment]
         end
         @@settings
@@ -152,6 +209,13 @@ module ParseResource
       def where(*args)
         Query.new(self).where(*args)
       end
+      
+      # Include the attributes of a parent ojbect in the results
+      # Similar to ActiveRecord eager loading
+      #
+      def include_object(parent)
+        Query.new(self).include_object(parent)
+      end
 
       # Add this at the end of a method chain to get the count of objects, instead of an Array of objects
       def count
@@ -223,13 +287,30 @@ module ParseResource
     end
 
     def create
-      resp = self.resource.post(@unsaved_attributes.to_json, :content_type => "application/json")
-      @attributes.merge!(JSON.parse(resp))
-      @attributes.merge!(@unsaved_attributes)
-      attributes = HashWithIndifferentAccess.new(attributes)
-      @unsaved_attributes = {}
-      create_setters!
-      self
+      opts = {:content_type => "application/json"}
+      attrs = @unsaved_attributes.to_json
+      result = self.resource.post(attrs, opts) do |resp, req, res, &block|
+        
+        case resp.code 
+        when 400
+          
+          # https://www.parse.com/docs/ios/api/Classes/PFConstants.html
+          error_response = JSON.parse(resp)
+          pe = ParseError.new(error_response["code"]).to_array
+          self.errors.add(pe[0], pe[1])
+        
+        else
+          @attributes.merge!(JSON.parse(resp))
+          @attributes.merge!(@unsaved_attributes)
+          attributes = HashWithIndifferentAccess.new(attributes)
+          @unsaved_attributes = {}
+          create_setters!
+        end
+        
+        self
+      end
+    
+      result
     end
 
     def save
@@ -244,7 +325,9 @@ module ParseResource
     end
 
     def update(attributes = {})
+      
       attributes = HashWithIndifferentAccess.new(attributes)
+        
       @unsaved_attributes.merge!(attributes)
 
       put_attrs = @unsaved_attributes
@@ -252,15 +335,31 @@ module ParseResource
       put_attrs.delete('createdAt')
       put_attrs.delete('updatedAt')
       put_attrs = put_attrs.to_json
+      
+      opts = {:content_type => "application/json"}
+      result = self.instance_resource.put(put_attrs, opts) do |resp, req, res, &block|
+
+        case resp.code
+        when 400
+          
+          # https://www.parse.com/docs/ios/api/Classes/PFConstants.html
+          error_response = JSON.parse(resp)
+          pe = ParseError.new(error_response["code"], error_response["error"]).to_array
+          self.errors.add(pe[0], pe[1])
+          
+        else
 
-      resp = self.instance_resource.put(put_attrs, :content_type => "application/json")
-
-      @attributes.merge!(JSON.parse(resp))
-      @attributes.merge!(@unsaved_attributes)
-      @unsaved_attributes = {}
-      create_setters!
+          @attributes.merge!(JSON.parse(resp))
+          @attributes.merge!(@unsaved_attributes)
+          @unsaved_attributes = {}
+          create_setters!
 
-      self
+          self
+        end
+        
+        result
+      end
+     
     end
 
     def update_attributes(attributes = {})

data/lib/parse_error.rb

@@ -0,0 +1,34 @@
+class ParseError
+  
+  def initialize(code, msg="")
+    @msg = msg
+    case code
+    when 202
+      @error = [:username, "must be unique"]
+    when 111
+      @error = [:base, "field set to incorrect type. Error code #{code}. #{msg}"]
+    when 125
+      @error = [:email, "must be valid"]
+    when 122
+      @error = [:file_name, "contains only a-zA-Z0-9_. characters and is between 1 and 36 characters."]
+    when 204
+      @error = [:email, "must not be missing"]
+    when 203
+      @error = [:email, "has already been taken"]
+    when 200
+      @error = [:username, "is missing or empty"]
+    when 201
+      @error = [:password, "is missing or empty"]
+    when 205
+      @error = [:user, "with specified email not found"]
+    else
+      raise "Parse error #{code}: #{@error}"
+    end
+  end
+  
+  def to_array
+    @error[1] = @error[1] + " " + @msg
+  end
+  
+end
+

data/lib/parse_resource.rb

@@ -1,6 +1,8 @@
 require 'base'
 require 'query'
 require 'parse_user'
+require 'parse_user_validator'
+require 'parse_error'
 
 module ParseResource
 end

data/lib/parse_user.rb

@@ -1,15 +1,26 @@
+require 'parse_user_validator'
+
 class ParseUser < ParseResource::Base
   fields :username, :password
+  
+  validates_presence_of :username
+  validates_presence_of :password
+  #validates_with ParseUserValidator, :on => :create, :on => :save
 
-  def self.login(username, password)
+  def self.authenticate(username, password)
     base_uri   = "https://api.parse.com/1/login"
     app_id     = settings['app_id']
     master_key = settings['master_key']
     resource = RestClient::Resource.new(base_uri, app_id, master_key)
     
-    resp = resource.get(:params => {:username => username, :password => password})
-    user = model_name.constantize.new(JSON.parse(resp), false)
-
-    user
+    begin
+      resp = resource.get(:params => {:username => username, :password => password})
+      user = model_name.constantize.new(JSON.parse(resp), false)
+            
+      user 
+    rescue 
+      false
+    end
+    
   end
 end

data/lib/parse_user_validator.rb

@@ -0,0 +1,8 @@
+class ParseUserValidator < ActiveModel::Validator
+  def validate(record)
+    @user = User.where(:username => record.username)
+    if @user.length > 0
+      record.errors[:username] << "is already taken."
+    end
+  end
+end

data/lib/query.rb

@@ -17,6 +17,11 @@ class Query
     criteria[:limit] = limit
     self
   end
+  
+  def include_object(parent)
+    criteria[:include] = parent.to_s
+    self
+  end
 
   #TODO: make this work
   #def skip(skip)

data/parse_resource.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "parse_resource"
-  s.version = "1.6.3"
+  s.version = "1.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alan deLevie"]
-  s.date = "2011-12-16"
+  s.date = "2011-12-30"
   s.description = ""
   s.email = "adelevie@gmail.com"
   s.extra_rdoc_files = [
@@ -25,8 +25,10 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/base.rb",
+    "lib/parse_error.rb",
     "lib/parse_resource.rb",
     "lib/parse_user.rb",
+    "lib/parse_user_validator.rb",
     "lib/query.rb",
     "parse_resource.gemspec",
     "rdoc/ParseResource.html",
@@ -36,7 +38,9 @@ Gem::Specification.new do |s|
     "rdoc/rdoc.css",
     "test/active_model_lint_test.rb",
     "test/helper.rb",
+    "test/test_associations.rb",
     "test/test_parse_resource.rb",
+    "test/test_parse_user.rb",
     "test/test_query.rb"
   ]
   s.homepage = "http://github.com/adelevie/parse_resource"

data/test/test_associations.rb

@@ -0,0 +1,88 @@
+require 'helper'
+require 'parse_resource'
+
+path = "parse_resource.yml"
+settings = YAML.load(ERB.new(File.new(path).read).result)['test']
+
+ParseResource::Base.load!(settings['app_id'], settings['master_key'])
+
+class Post < ParseResource::Base
+  belongs_to :author
+  fields :title, :body
+end
+
+class Author < ParseResource::Base
+  has_many :posts
+  field :name
+end
+
+class TestAssociations < Test::Unit::TestCase
+  
+  def setup
+    Post.destroy_all
+    Author.destroy_all
+  end
+  
+  
+  def teardown
+    Post.destroy_all
+    Author.destroy_all
+  end
+
+  def test_responds_to_has_many
+    #author = Author.create(:name => "alan")
+    author = Author.new
+    assert_equal true, author.respond_to?(:posts)
+  end
+
+  def test_has_many_returns_an_array
+    author = Author.create(:name => "alex")
+    assert_equal true, author.posts.is_a?(Array)
+  end
+  
+  def test_relational_query
+    a = Author.create(:name => "JK Rowling_relational_query")
+    p = Post.create(:title => "test relational query")
+    p.author = a.to_pointer
+    p.save
+    post = Post.include_object(:author).where(:title => "test relational query").first
+    assert_equal Post, post.class
+    assert_equal true, post.author.is_a?(Author)
+  end
+  
+  def test_has_many_parent_getter
+    a = Author.create(:name => "RL Stine")
+    p = Post.create(:title => "Goosebumps_has_many_parent_getter")
+    p.author = a.to_pointer
+    p.save
+    assert_equal a.posts.class, Array
+  end
+  
+  def test_has_many_child_getter
+    a = Author.create(:name => "JK Rowling_child_getter")
+    p = Post.create(:title => "test has_many child getter")
+    p.author = a.to_pointer
+    p.save
+    assert_equal p.author.id, a.id
+  end
+  
+  def test_belongs_to_setter  
+    Author.destroy_all
+    Post.destroy_all  
+    aa = Author.create(:name => "Shmalter Kirn")
+    pp = Post.create(:title => "Shmup in the Air")
+    pp.author = aa.to_pointer
+    pp.save
+    assert aa.id
+    assert_equal aa.id, pp.author.id
+  end
+  
+  def test_has_many_setter
+    author = Author.create(:name => "R.L. Stine")
+    post = Post.create(:title => "Goosebumps_has_many_setter")
+    author.posts << post
+    assert_equal true, (author.posts.length > 0)
+    assert_equal Post, author.posts[0].class
+  end
+
+end

data/test/test_parse_resource.rb

@@ -12,6 +12,7 @@ class Post < ParseResource::Base
 end
 
 class Author < ParseResource::Base
+  has_many :posts
   field :name
 end
 
@@ -83,12 +84,12 @@ class TestParseResource < Test::Unit::TestCase
 
   def test_chained_wheres
     Post.destroy_all
-    p1 = Post.create(:title => "where1", :author => "where2")
-    p2 = Post.create(:title => "where1", :author => "foobar")
-    p = Post.where(:title => "where1").where(:author => "where2")
-    assert_equal 1, p.length
-    assert_equal p.first.title, p1.title 
-    assert_equal p.first.author, p1.author
+    p1 = Post.create(:title => "chained_wheres", :body => "testing")
+    p2 = Post.create(:title => "chained_wheres", :body => "testing_2")
+    query = Post.where(:title => "chained_wheres").where(:body => "testing")
+    p3 = query.first
+    
+    assert_equal p3.id, p1.id
   end
 
   def test_limit
@@ -129,7 +130,7 @@ class TestParseResource < Test::Unit::TestCase
 
   def test_save
     @post = Post.create(:title => "testing save")
-    assert @post.save
+    @post.save
     assert @post.attributes['objectId']
     assert @post.attributes['updatedAt']
     assert @post.attributes['createdAt']
@@ -138,7 +139,8 @@ class TestParseResource < Test::Unit::TestCase
   def test_each
     Post.destroy_all
     4.times do |i|
-      Post.create(:title => "each", :author => i.to_s)
+      #Post.create(:title => "each", :author => i.to_s)
+      Post.create(:title => "each")
     end
     posts = Post.where(:title => "each")
     posts.each do |p|
@@ -149,7 +151,7 @@ class TestParseResource < Test::Unit::TestCase
   def test_map
     Post.destroy_all
     4.times do |i|
-      Post.create(:title => "map", :author => i.to_s)
+      Post.create(:title => "map")
     end
     posts = Post.where(:title => "map")
     assert_equal posts.map {|p| p}.class, Array

data/test/test_parse_user.rb

@@ -0,0 +1,51 @@
+require 'helper'
+require 'parse_resource'
+
+path = "parse_resource.yml"
+settings = YAML.load(ERB.new(File.new(path).read).result)['test']
+
+ParseResource::Base.load!(settings['app_id'], settings['master_key'])
+
+class User < ParseUser
+end
+
+class TestParseUser < Test::Unit::TestCase
+  def setup
+    User.destroy_all
+  end
+  
+  def teardown
+    User.destroy_all
+  end
+  
+  def test_user_should_not_save_without_username_and_password
+    u = User.new
+    assert_equal u.valid?, false
+    u.username = "fakename"
+    assert_equal u.valid?, false
+    u.password = "fakepass"
+    assert_equal u.valid?, true
+    assert_not_equal u.save, false
+    assert_equal u.id.class, String
+  end
+  
+  def test_username_should_be_unique
+    User.destroy_all
+    u = User.create(:username => "alan", :password => "12345")
+    u2 = User.new(:username => "alan", :password => "56789")
+    u2.save
+    assert_equal u2.errors.count, 1
+    assert_equal nil, u2.id
+  end
+  
+  def test_authenticate
+    user = "fake_person"
+    pass = "fake_pass"
+    u1 = User.create(:username => user, :password => pass)
+    u2 = User.authenticate(user, pass)
+    assert_equal u1.id, u2.id
+    u3 = User.authenticate("wrong_username", "wrong_pass")
+    assert_equal u3, false
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parse_resource
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-16 00:00:00.000000000Z
+date: 2011-12-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &79516440 !ruby/object:Gem::Requirement
+  requirement: &70190990670500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *79516440
+  version_requirements: *70190990670500
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &79515910 !ruby/object:Gem::Requirement
+  requirement: &70190990669960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *79515910
+  version_requirements: *70190990669960
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &79515450 !ruby/object:Gem::Requirement
+  requirement: &70190990669100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *79515450
+  version_requirements: *70190990669100
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &79514900 !ruby/object:Gem::Requirement
+  requirement: &70190990668540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *79514900
+  version_requirements: *70190990668540
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &79514250 !ruby/object:Gem::Requirement
+  requirement: &70190990668040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *79514250
+  version_requirements: *70190990668040
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &79513330 !ruby/object:Gem::Requirement
+  requirement: &70190990667460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *79513330
+  version_requirements: *70190990667460
 - !ruby/object:Gem::Dependency
   name: reek
-  requirement: &79512680 !ruby/object:Gem::Requirement
+  requirement: &70190990666960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.2.8
   type: :development
   prerelease: false
-  version_requirements: *79512680
+  version_requirements: *70190990666960
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &79511730 !ruby/object:Gem::Requirement
+  requirement: &70190990666460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *79511730
+  version_requirements: *70190990666460
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &79510530 !ruby/object:Gem::Requirement
+  requirement: &70190990665980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *79510530
+  version_requirements: *70190990665980
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &79509440 !ruby/object:Gem::Requirement
+  requirement: &70190990665440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *79509440
+  version_requirements: *70190990665440
 description: ''
 email: adelevie@gmail.com
 executables: []
@@ -137,8 +137,10 @@ files:
 - Rakefile
 - VERSION
 - lib/base.rb
+- lib/parse_error.rb
 - lib/parse_resource.rb
 - lib/parse_user.rb
+- lib/parse_user_validator.rb
 - lib/query.rb
 - parse_resource.gemspec
 - rdoc/ParseResource.html
@@ -148,7 +150,9 @@ files:
 - rdoc/rdoc.css
 - test/active_model_lint_test.rb
 - test/helper.rb
+- test/test_associations.rb
 - test/test_parse_resource.rb
+- test/test_parse_user.rb
 - test/test_query.rb
 homepage: http://github.com/adelevie/parse_resource
 licenses:
@@ -165,7 +169,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 47696225
+      hash: 286800748326139219
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: