stackmob 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+gem "oauth", "~> 0.4.5"
+gem "yajl-ruby", "~> 0.8.2", :require => "yajl"
+
+group :development do
+  gem "minitest", ">= 0"
+  gem "yard", "~> 0.6.0"
+  gem "cucumber", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "mocha", ">= 0"
+  gem "rack-test"
+  gem "bluecloth"
+end

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bluecloth (2.1.0)
+    builder (3.0.0)
+    cucumber (1.0.2)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.4.5)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.4.5)
+      json (>= 1.4.6)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.3)
+    minitest (2.3.1)
+    mocha (0.9.12)
+    oauth (0.4.5)
+    rack (1.3.2)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2)
+    rcov (0.9.9)
+    term-ansicolor (1.0.6)
+    yajl-ruby (0.8.2)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bluecloth
+  bundler (~> 1.0.0)
+  cucumber
+  jeweler (~> 1.6.4)
+  minitest
+  mocha
+  oauth (~> 0.4.5)
+  rack-test
+  rcov
+  yajl-ruby (~> 0.8.2)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/README.md

@@ -0,0 +1,210 @@
+# StackMob
+
+This gem is meant to be used along with the StackMob add-on for Heroku. Using this gem you can run your StackMob application's custom code on Heroku using Rails 3 & Sinatra (Rails 2.3.x Support Coming Soon).
+
+## Adding StackMob to your Rails 3 Application
+
+Add the following to your Gemfile and run `bundle install`:
+
+    gem "stackmob", :require => "stackmob/rails"
+    
+## Configuring Your Application    
+    
+The gem requires a few configuration details that need to be added to the file `config/stackmob.yml`. You will need the name of the application you created, as well as your public and private keys for both development (sandbox) and production from the StackMob add-on dashboard.
+
+    # example config/stackmob.yml
+	sm_app_name: StackMob App Name
+	sm_client_name: Your StackMob Client Name
+    heroku_app_name: Heroku App Name
+
+    development:	
+      key: Your StackMob Sandbox Public Key
+      secret: Your StackMob Sandbox Private Key
+
+    production:	
+      key: Your StackMob Production Public Key
+      secret: Your StackMob Production Private Key
+    
+Additionally, you will want to include some helpful methods in your controllers. Add the line below to the `ApplicationController`. Check out "Interacting With Your API in Your Application" for more  details about the methods provided by StackMob::Helpers.
+
+    include StackMob::Helpers 
+
+## Interacting with CRUD from the Console
+
+Once the gem is added to your application & configured you can take things for a test drive. You'll need to grab your public & private sandbox keys from the StackMob add-on page within the Heroku dashboard. Once you have those run `rails console`. All of the classes you will use in your application function using a class called `StackMob::Client`. You will not be exposed to this class in your controllers but to test in the console you will need to create an instance:
+
+    >> stackmob_client = StackMob::Client.new(StackMob.dev_url, StackMob.app_name, StackMob::SANDBOX, StackMob.key, StackMob.secret)
+     => #<StackMob::Client:0x007fae99839cb8 @app_name= ...>
+    
+Although you can use the `StackMob::Client` to interact with the CRUD methods of your API, you will be using `StackMob::DataStore` in your application, which provides a much simpler interface to perform operations.
+
+    >> datastore = StackMob::DataStore.new(stackmob_client)
+     => #<StackMob::DataStore:0x007fae991eebd8 ...>
+
+The simplest operation to perform is to list the application's schema:
+
+    >> datastore.api_schema
+     => {"user"=>{"properties"=>{"username"=> ...
+
+To fetch all records for an object use `StackMob::DatStore#get`: 
+
+    >> datastore.get(:user)
+	 => [{"username"=>"Some User", "lastmoddate"=>1312996693261, ...
+
+Fetch a single record using `StackMob::DataStore#get_one`:
+   
+    >> datastore.get_one(:user, :username => "Some User")
+	 => {"username"=>"Some User", "lastmoddate"=>1312996693261, ...
+	 
+    >> datastore.get_one(:user, :username => "D.N.E")
+	 => nil
+	 
+Create and update records: 
+   
+    >> datastore.create(:user, :username => "newuser", :name => "First Last") 
+	 => true	
+	 
+	>> datastore.update(:user, "newuser", :name => "New Name") 
+	 => true
+	 
+	 
+Delete records
+
+    >> datastore.delete(:user, :username => "newuser")
+     => true
+	 
+## Interacting With Your API in Your Application
+
+When you include `StackMob::Helpers` in your `ApplicationController` you get a couple of convenience methods to use in your controller actions. `sm_datastore` and `sm_push` provide per-request instances of `StackMob::DataStore` & `StackMob::Push` (for more information on Push see "Sending Push Messages from your Application"). An example action, which returns a list of usernames for each user object record is below:
+
+    class MyController < ApplicationController
+	  
+	  def username_list
+		users = sm_datastore.get(:user)
+		
+		render :json => { :usernames => usernames.map { |u| u['username'] }
+		
+      rescue StackMob::Client::RequestError # something went wrong making the request
+	    render :json => {"error": "could not communicate with StackMob Servers"}
+      end
+	  	
+    end
+
+### Sending Push Messages from your Application
+
+`StackMob::Push` allows you to interact with the Push Notification portion of your StackMob API. The examples below show how to register a device token, send a message to a single user or device token and how to send a broadcast message to all users.
+
+    # Register a User With His/Her Device Token in your Controller
+	sm_push.register("user_id", "user_device_token")
+	
+	# Send a Push Message to a User using Device Token
+	sm_push.send_message("user_device_token", :sound => "yoursoundfile.mp3", :alert => "The Message to Show the User", :badge => 2)
+	
+	# Send a Push Message to a User using the User Object's Primary Key
+	sm_push.send_message("primary_key_value", :sound => "yoursendfile.mp3", :alert => "Message", :badge => 0, :recipients_are_users => true)
+	
+	# Broadcast a Message
+	sm_push.broadcast(:badge => 1, :sound => "audiofile.mp3", :alert => "The Broadcasted Message")
+
+Only the `:alert` key is required when sending or broadcasting messages. 
+
+## Using Sinatra
+
+You can also write your application using Sinatra. Create a Gemfile like the one below and run `bundle install`. You also need to create a `config/stackmob.yml` like the one above.
+
+    source 'http://rubygems.org'
+	
+	gem 'sinatra'
+	gem 'stackmob', :require => 'stackmob/sinatra'
+	
+In your `config.ru` file add the following line:
+
+    use StackMob::Rack::SimpleOAuthProvider
+	
+To use the `StackMob::Helpers` module in a classic Sinatra application:
+
+    require 'bundler/setup'
+
+	require 'sinatra'
+	require 'stackmob/sinatra'
+	
+	before do
+	  content_type :json # your responses should always return a JSON content type
+    end
+	
+	...
+	
+To use it in a modular application:
+
+    require 'bundler/setup'
+	
+    require 'sinatra/base'
+	require 'stackmob/sinatra'
+	
+	class MyApp < Sinatra::Base
+	  helpers StackMob::Helpers
+	  
+	  ...
+	  
+    end
+	
+### Adding Rake Tasks to a Sinatra Application
+
+Add the following lines to your Rakefile in order to add the `stackmob:deploy` task. 
+
+	require 'bundler/setup' # add this line if its not already included in your Rakefile
+	require 'stackmob/tasks'
+
+## Deploying
+
+In order to deploy your Rails application you will first need to deploy your StackMob API to production. To do so, go to the StackMob add-on page, click the deploy tab, and select "Deploy to Live API". Once on the deployment page, select "Create from Sandbox" for which snapshot to deploy and "API Version 1" for which version to deploy to. Add any comments in the deploy notes field and click deploy. 
+
+Deploying your Heroku application only requires one additional step. After you have pushed your changes to Heroku you will need to run:
+
+    heroku run rake stackmob:deploy
+	
+This rake task will inform the StackMob servers that you have deployed a new version of your application as well as update any information that may be needed to proxy requests to your application.
+
+## Running your Application Locally in Development
+
+The railtie provided with this gem adds a simple oauth provider into the middleware stack. When making requests to your Rails or Sinatra application while its running locally you can either use the oauth gem, installed as a dependency to this one, with your public/private development keys in `config/stackmob.yml` or add the line `no_oauth: true` under the development section of the same config file. Adding the `no_oauth: true` line to `config/stackmob.yml` will only prevent verification of oauth keys locally. It will not turn off the middleware in production even if the option is specified under the production section of the config file. 
+
+## Contributing to stackmob gem
+
+The stackmob Ruby Gem is Apache 2.0 licensed (see LICENSE.txt) and we look forward to your contributions. 
+
+### Reporting Bugs
+
+We are using [GitHub Issues](https://github.com/stackmob/stackmob-ruby/issues) to track feature requests and bugs.
+
+### Running the Tests
+
+Before submitting a pull request add any appropriate tests and run them along with the existing ones. The gem includes tasks to run unit & integration tests seperately or together. Before running the integration tests you will need to setup a few things. First, create a new application on your StackMob account named "test". In the new application, create a User Object named "user", with one extra string field, "name". Finally, you will have to set a few environment variables. If your using RVM, a good place to put these is your .rvmrc file.
+
+    export STACKMOB_TEST_URL="YOURDOMAIN.stackmob.com"
+    export STACKMOB_TEST_KEY="YOUR TEST APP PUB KEY"
+    export STACKMOB_TEST_SECRET="YOUR TEST APP PRIV KEY"
+    
+You can run the tests with one of these three Rake tasks:
+
+    rake test:all
+    rake test:unit
+    rake test:integration
+
+## Copyright
+
+Copyright 2011 StackMob
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+