dm-parse 0.1.0 → 0.2.0

data/README.md

@@ -0,0 +1,94 @@
+# dm-parse
+
+A DataMapper extension for [Parse](https://parse.com/), include an adapter and some types for Parse.
+
+## Installation
+
+Include in your `Gemfile`:
+
+```ruby
+gem "dm-parse"
+```
+
+Or just gem install:
+
+```bash
+gem install dm-parse
+```
+
+## Usage
+
+To setup the adapter:
+
+```ruby
+DataMapper.setup(:default, adapter: :parse, app_id: "your-id", api_key: "your-rest-api-key")
+```
+
+To setup with Master Key:
+
+```ruby
+DataMapper.setup(:default, adapter: :parse, app_id: "your-id", api_key: "your-master-key", master: true)
+```
+
+To define model for parse, use `is :parse`:
+
+```ruby
+class Article
+  include DataMapper::Resource
+
+  is :parse # it defines id, created_at and updated_at for you
+
+  property :title,      String
+  property :body,       Text
+  property :rank,       Integer
+  property :closed_at,  ParseDate # Date type for Parse
+
+  has n, :comments
+end
+
+class Comment
+  include DataMapper::Resource
+
+  is :parse
+
+  property :body,       Text
+
+  belongs_to :article
+end
+```
+
+To define a user model, use `is :parse_user`:
+
+```ruby
+class User
+  include DataMapper::Resource
+
+  # more than :parse, it also defines username, password and email.
+  # it also sets the default storage_names to "_User"
+  is :parse_user
+  storage_names[:master] = "_User"
+end
+```
+
+By this, you can use `User.authenticate(username, password)` to sign in, and use `User.request_password_reset(email)` to reset password.
+
+## Special properties for Parse
+* ParseKey: the property for objectId, `is :parse` will define it for you.
+* ParsePointer: the pointer, you just need to give it objectId value.
+* ParseDate: the date, use it like you use DateTime.
+* ParseFile: the file, just give it file url.
+
+## Contributing to dm-parse
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Zhi-Qiang Lei. See LICENSE.txt for
+further details.

data/Rakefile

@@ -22,10 +22,6 @@ Jeweler::Tasks.new do |gem|
   gem.email = "zhiqiang.lei@gmail.com"
   gem.authors = ["Zhi-Qiang Lei"]
   # dependencies defined in Gemfile
-  gem.add_dependency "dm-core", ">= 1.2"
-  gem.add_dependency "dm-validations", ">= 1.2"
-  gem.add_dependency "activesupport", ">= 3.2"
-  gem.add_dependency "nestful", ">= 0.0.8"
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/dm-parse.gemspec

@@ -0,0 +1,101 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "dm-parse"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Zhi-Qiang Lei"]
+  s.date = "2012-06-28"
+  s.description = "An extension to make DataMapper working on Parse.com"
+  s.email = "zhiqiang.lei@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "dm-parse.gemspec",
+    "lib/adapters/parse_adapter.rb",
+    "lib/collection.rb",
+    "lib/dm-parse.rb",
+    "lib/is/parse.rb",
+    "lib/parse/query.rb",
+    "lib/parse/resource.rb",
+    "lib/property/parse_date.rb",
+    "lib/property/parse_file.rb",
+    "lib/property/parse_geo_point.rb",
+    "lib/property/parse_key.rb",
+    "lib/property/parse_pointer.rb",
+    "spec/integration_spec.rb",
+    "spec/parse_adapter_spec.rb",
+    "spec/parse_date_spec.rb",
+    "spec/parse_file_spec.rb",
+    "spec/parse_geo_point_spec.rb",
+    "spec/parse_key_spec.rb",
+    "spec/parse_pointer_spec.rb",
+    "spec/query_spec.rb",
+    "spec/resource_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "https://github.com/siegfried/dm-parse"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "An extension to make DataMapper working on Parse.com"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, [">= 1.2"])
+      s.add_runtime_dependency(%q<dm-validations>, [">= 1.2"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.2"])
+      s.add_runtime_dependency(%q<nestful>, [">= 0.0.8"])
+      s.add_development_dependency(%q<rspec>, [">= 2.10.0"])
+      s.add_development_dependency(%q<yard>, [">= 0.7"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0.6"])
+      s.add_development_dependency(%q<debugger>, [">= 1.1"])
+    else
+      s.add_dependency(%q<dm-core>, [">= 1.2"])
+      s.add_dependency(%q<dm-validations>, [">= 1.2"])
+      s.add_dependency(%q<activesupport>, [">= 3.2"])
+      s.add_dependency(%q<nestful>, [">= 0.0.8"])
+      s.add_dependency(%q<rspec>, [">= 2.10.0"])
+      s.add_dependency(%q<yard>, [">= 0.7"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0.6"])
+      s.add_dependency(%q<debugger>, [">= 1.1"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, [">= 1.2"])
+    s.add_dependency(%q<dm-validations>, [">= 1.2"])
+    s.add_dependency(%q<activesupport>, [">= 3.2"])
+    s.add_dependency(%q<nestful>, [">= 0.0.8"])
+    s.add_dependency(%q<rspec>, [">= 2.10.0"])
+    s.add_dependency(%q<yard>, [">= 0.7"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0.6"])
+    s.add_dependency(%q<debugger>, [">= 1.1"])
+  end
+end
+

data/lib/dm-parse.rb

@@ -6,6 +6,8 @@ require "collection"
 require "property/parse_key"
 require "property/parse_pointer"
 require "property/parse_date"
+require "property/parse_file"
+require "property/parse_geo_point"
 require "parse/resource"
 require "parse/query"
 require "adapters/parse_adapter"

data/lib/property/parse_file.rb

@@ -0,0 +1,17 @@
+module DataMapper
+  class Property
+
+    class ParseFile < Object
+
+      def dump(value)
+        value && {"__type" => "File", "name" => value.to_s}
+      end
+
+      def load(value)
+        value && value["name"].to_s
+      end
+
+    end
+
+  end
+end

data/lib/property/parse_geo_point.rb

@@ -0,0 +1,21 @@
+module DataMapper
+  class Property
+
+    class ParseGeoPoint < Object
+
+      def dump(value)
+        value && {"__type" => "GeoPoint", "latitude" => value["lat"].to_f, "longitude" => value["lng"].to_f}
+      end
+
+      def load(value)
+        value && {"lat" => value["latitude"], "lng" => value["longitude"]}
+      end
+
+      def valid?(value)
+        return false if value && (value["lat"].nil? || value["lng"].nil?)
+        super
+      end
+    end
+
+  end
+end

data/spec/parse_file_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe DataMapper::Property::ParseFile do
+  subject { property }
+
+  let(:property) { Article.properties[:attachment] }
+
+  describe "#dump" do
+    subject { property.dump value }
+
+    let(:value) { "http://a.cn/a.png" }
+
+    it { should eq("__type" => "File", "name" => value) }
+
+    context "when value is nil" do
+      let(:value) { nil }
+
+      it { should be_nil }
+    end
+  end
+
+  describe "#load" do
+    subject { property.load value }
+
+    let(:value) { { "__type" => "File", "name" => "http://a.cn/a.png" } }
+
+    it { should eq(value["name"]) }
+
+    context "when value is nil" do
+      let(:value) { nil }
+
+      it { should be_nil }
+    end
+  end
+
+  describe "#valid?" do
+    subject { property.valid? value }
+
+    let(:value) { "http://a.cn/a.png" }
+
+    it { should be_true }
+  end
+end

data/spec/parse_geo_point_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+describe DataMapper::Property::ParseGeoPoint do
+  subject { property }
+
+  let(:property) { User.properties[:location] }
+
+  describe "#dump" do
+    subject { property.dump value }
+
+    let(:value) { { "lat" => "20", "lng" => "50" } }
+
+    it { should eq("__type" => "GeoPoint", "latitude" => value["lat"].to_f, "longitude" => value["lng"].to_f) }
+
+    context "when value is nil" do
+      let(:value) { nil }
+
+      it { should be_nil }
+    end
+  end
+
+  describe "#load" do
+    subject { property.load value }
+
+    let(:value) { { "__type" => "GeoPoint", "latitude" => 20.0, "longitude" => 50.0 } }
+
+    it { should eq("lat" => value["latitude"], "lng" => value["longitude"]) }
+
+    context "when value is nil" do
+      let(:value) { nil }
+
+      it { should be_nil }
+    end
+  end
+
+  describe "#valid?" do
+    subject { property.valid? value }
+
+    let(:value) { { "lat" => lat, "lng" => lng } }
+    let(:lat)   { "20.0" }
+    let(:lng)   { "50.0" }
+
+    it { should be_true }
+
+    context "when lat is nil" do
+      let(:lat) { nil }
+
+      it { should be_false }
+    end
+
+    context "when lng is nil" do
+      let(:lng) { nil }
+
+      it { should be_false }
+    end
+
+    context "when value is nil" do
+      let(:value) { nil }
+
+      it { should be_true }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -29,6 +29,7 @@ class User
 
   is :parse_user
   storage_names[:master] = "_User"
+  property :location, ParseGeoPoint
 end
 
 class Article
@@ -40,6 +41,7 @@ class Article
   property :body,       Text
   property :rank,       Integer
   property :closed_at,  ParseDate
+  property :attachment, ParseFile
 
   has n, :comments
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dm-parse
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -187,76 +187,13 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: dm-core
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: dm-validations
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: nestful
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.0.8
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.0.8
 description: An extension to make DataMapper working on Parse.com
 email: zhiqiang.lei@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
+- README.md
 - README.rdoc
 files:
 - .document
@@ -264,9 +201,11 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- README.md
 - README.rdoc
 - Rakefile
 - VERSION
+- dm-parse.gemspec
 - lib/adapters/parse_adapter.rb
 - lib/collection.rb
 - lib/dm-parse.rb
@@ -274,11 +213,15 @@ files:
 - lib/parse/query.rb
 - lib/parse/resource.rb
 - lib/property/parse_date.rb
+- lib/property/parse_file.rb
+- lib/property/parse_geo_point.rb
 - lib/property/parse_key.rb
 - lib/property/parse_pointer.rb
 - spec/integration_spec.rb
 - spec/parse_adapter_spec.rb
 - spec/parse_date_spec.rb
+- spec/parse_file_spec.rb
+- spec/parse_geo_point_spec.rb
 - spec/parse_key_spec.rb
 - spec/parse_pointer_spec.rb
 - spec/query_spec.rb
@@ -299,7 +242,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2371305649373377207
+      hash: -458598293042877060
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: