stackmob 0.0.1 → 0.0.2

data/README.md

@@ -1,16 +1,24 @@
 # 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).
+This gem is meant to be used along with the StackMob add-on for Heroku. Using this gem you can extend your StackMob REST API using a Rails 3 or Sinatra application (Rails 2.3.x Support Coming Soon) deployed on Heroku. 
+
+When you deploy your application your routes will become available via the production version of your StackMob API. StackMob will proxy any API call of the form `http://[SUBDOMAIN].mob2.stackmob.com/api/[VERSION]/[APPNAME]/heroku/proxy/[ROUTE]` to your Heroku application. 
 
 ## Adding StackMob to your Rails 3 Application
 
 Add the following to your Gemfile and run `bundle install`:
 
     gem "stackmob", :require => "stackmob/rails"
+	
+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 
+	    
+## Configuring Your Application (For Local Development)
+
+This section only pertains to setting up your Rails or Sinatra application for development & testing. If you wish solely to deploy to Heroku you can skip this section. 
     
-## 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. When specifying your Heroku hostname, if your application is available under the herokuapp.com domain as well as heroku.com, use the herokuapp.com domain otherwise, use heroku.com. 
+For local development, a few configuration details need to be set in the file `config/stackmob.yml`. You will need your subdomain, 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. When specifying your Heroku hostname, if your application is available under the herokuapp.com domain as well as heroku.com, use the herokuapp.com domain otherwise, use heroku.com. 
 
     # example config/stackmob.yml
 	sm_app_name: StackMob App Name
@@ -24,10 +32,8 @@ The gem requires a few configuration details that need to be added to the file `
     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 
+    	
+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. 
 
 ## Interacting with CRUD from the Console
 
@@ -175,7 +181,7 @@ You can then proxy requests to your application using the `StackMob::Client#requ
 
 ## 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
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/stackmob.rb

@@ -32,19 +32,19 @@ module StackMob
   end
   
   def self.secret
-    StackMob.config[sm_env_str]['secret']
+    ENV[sm_env_key_str(:private_key)] || StackMob.config[sm_env_str]['secret']
   end
 
   def self.key
-    StackMob.config[sm_env_str]['key']
+    ENV[sm_env_key_str(:public_key)] || StackMob.config[sm_env_str]['key']
   end
 
   def self.app_name
-    StackMob.config['sm_app_name']
+    ENV['STACKMOB_APP_NAME'] || StackMob.config['sm_app_name']
   end
 
   def self.client_name
-    StackMob.config['sm_client_name']
+    ENV['STACKMOB_CLIENT_NAME'] || StackMob.config['sm_client_name']
   end
 
   def self.dev_url
@@ -63,5 +63,9 @@ module StackMob
     ENV["RACK_ENV"] == "production"
   end
 
+  def self.sm_env_key_str(suffix)
+    "STACKMOB_" + ((is_production?) ? "PROD" : "SAND") + "_#{suffix.upcase}"
+  end
+
 
 end

data/stackmob.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stackmob}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{StackMob}]
-  s.date = %q{2011-08-29}
+  s.date = %q{2011-09-12}
   s.description = %q{Support Gem for StackMob Heroku Add-On}
   s.email = %q{jordan@stackmob.com}
   s.extra_rdoc_files = [
@@ -46,7 +46,8 @@ Gem::Specification.new do |s|
     "test/unit/stackmob/test_client.rb",
     "test/unit/stackmob/test_data_store.rb",
     "test/unit/stackmob/test_deployer.rb",
-    "test/unit/stackmob/test_push.rb"
+    "test/unit/stackmob/test_push.rb",
+    "test/unit/test_stackmob.rb"
   ]
   s.homepage = %q{http://github.com/stackmob/stackmob-ruby}
   s.licenses = [%q{MIT}]

data/test/unit/test_stackmob.rb

@@ -0,0 +1,129 @@
+require 'helper'
+
+class StackMobTestCase < MiniTest::Unit::TestCase
+
+  def setup
+    @config_dev_key = "config_dev_key"
+    @config_dev_secret = "config_dev_secret"
+    @config_prod_key = "config_prod_key"
+    @config_prod_secret = "config_prod_secret"
+    @config_app_name = "config_app_name"
+    @config_client_name = "config_client_name"
+
+    @env_dev_key = "env_dev_key"
+    @env_dev_secret = "env_dev_secret"
+    @env_prod_key = "env_prod_key"
+    @env_prod_secret = "env_prod_secret"
+    @env_app_name = "env_app_name"
+    @env_client_name = "env_client_name"
+
+    StackMob.stubs(:config).returns("sm_client_name" => @config_client_name, "sm_app_name" => @config_app_name, 
+                                    "development" => {"key" => @config_dev_key, "secret" => @config_dev_secret}, "production" => {"key" => @config_prod_key, "secret" => @config_prod_secret})
+  end
+
+  def test_fetch_app_name_when_no_env_key_exists
+    assert_equal @config_app_name, StackMob.app_name
+  end
+
+  def test_fetch_app_name_when_env_key_exists
+    ENV["STACKMOB_APP_NAME"] = @env_app_name
+
+    assert_equal @env_app_name, StackMob.app_name
+
+    ENV["STACKMOB_APP_NAME"] = nil
+  end
+
+  def test_fetch_client_name_when_no_env_key_exists
+    assert_equal @config_client_name, StackMob.client_name
+  end
+
+  def test_fetch_client_name_when_env_key_exists
+    ENV["STACKMOB_CLIENT_NAME"] = @env_client_name
+
+    assert_equal @env_client_name, StackMob.client_name
+
+    ENV["STACKMOB_CLIENT_NAME"] = nil
+  end
+
+  def test_fetch_dev_key_when_no_env_key_exists
+    previous_rack_env = ENV["RACK_ENV"]
+    ENV["RACK_ENV"] = "development"
+    
+    assert_equal @config_dev_key, StackMob.key
+
+    ENV["RACK_ENV"] = previous_rack_env
+  end
+
+  def test_fetch_dev_secret_when_no_env_secret_exists
+    previous_rack_env = ENV["RACK_ENV"]
+    ENV["RACK_ENV"] = "development"
+
+    assert_equal @config_dev_secret, StackMob.secret
+
+    ENV["RACK_ENV"] = previous_rack_env
+  end
+
+  def test_fetch_prod_key_when_no_env_key_exists
+    previous_rack_env = ENV["RACK_ENV"]
+    ENV["RACK_ENV"] = "production"
+    
+    assert_equal @config_prod_key, StackMob.key
+
+    ENV["RACK_ENV"] = previous_rack_env
+  end
+
+  def test_fetch_prod_secret_when_no_env_secret_exists
+    previous_rack_env = ENV["RACK_ENV"]
+    ENV["RACK_ENV"] = "production"
+
+    assert_equal @config_prod_secret, StackMob.secret
+
+    ENV["RACK_ENV"] = previous_rack_env
+  end
+
+  def test_fetches_dev_key_from_env_when_exists
+    previous_rack_env = ENV["RACK_ENV"]
+    ENV["RACK_ENV"] = "development"
+    ENV["STACKMOB_SAND_PUBLIC_KEY"] = @env_dev_key
+
+    assert_equal @env_dev_key, StackMob.key
+    
+    ENV["STACKMOB_SAND_PUBLIC_KEY"] = nil
+    ENV["RACK_ENV"] = previous_rack_env
+  end
+
+  def test_fetches_dev_secret_from_env_when_exists
+    previous_rack_env = ENV["RACK_ENV"]
+    ENV["RACK_ENV"] = "development"
+    ENV["STACKMOB_SAND_PRIVATE_KEY"] = @env_dev_secret
+
+    assert_equal @env_dev_secret, StackMob.secret
+
+    ENV["STACKMOB_SAND_PRIVATE_KEY"] = nil
+    ENV["RACK_ENV"] = previous_rack_env
+  end
+
+  def test_fetches_prod_key_from_env_when_exists
+    previous_rack_env = ENV["RACK_ENV"]
+    ENV["RACK_ENV"] = "production"
+    ENV["STACKMOB_PROD_PUBLIC_KEY"] = @env_prod_key
+    
+    assert_equal @env_prod_key, StackMob.key
+
+    ENV["RACK_ENV"] = previous_rack_env
+    ENV["STACKMOB_PROD_PUBLIC_KEY"] = nil
+  end
+
+  def test_fetches_prod_secret_from_env_when_exists
+    previous_rack_env = ENV["RACK_ENV"]
+    ENV["RACK_ENV"] = "production"
+    ENV["STACKMOB_PROD_PRIVATE_KEY"] = @env_prod_secret
+    
+    assert_equal @env_prod_secret, StackMob.secret
+
+    ENV["RACK_ENV"] = previous_rack_env
+    ENV["STACKMOB_PROD_PRIVATE_KEY"] = nil
+  end
+
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stackmob
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - StackMob
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-29 00:00:00 Z
+date: 2011-09-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -221,6 +221,7 @@ files:
 - test/unit/stackmob/test_data_store.rb
 - test/unit/stackmob/test_deployer.rb
 - test/unit/stackmob/test_push.rb
+- test/unit/test_stackmob.rb
 homepage: http://github.com/stackmob/stackmob-ruby
 licenses: 
 - MIT