# 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, give it a hash contain "name" and "url", or a IO object from web form, it will be uploaded.

## Limits
* Does not support many-to-many relationships.

## 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.