stackmob 0.0.2 → 0.1.0

data/README.md

@@ -17,7 +17,7 @@ Additionally, you will want to include some helpful methods in your controllers.
 ## 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. 
-    
+
 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
@@ -171,7 +171,7 @@ Deploying your Heroku application only requires one additional step. After you h
 	
 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.
 
-Once your API & Application are deployed, you can, of course, start using it with the [StackMob iOS SDK](https://github.com/stackmob/StackMob_iOS) but if you would like to take things for a test drive, you can also use `StackMob::Client`. Create a client to use your production keys like the example below:
+Once your API & Application are deployed, you can, of course, start using it with the <a href="https://github.com/stackmob/StackMob_iOS">StackMob iOS SDK</a> but if you would like to take things for a test drive, you can also use `StackMob::Client`. Create a client to use your production keys like the example below:
 
     client = StackMob::Client.new(StackMob.dev_url, StackMob.app_name, StackMob::PRODUCTION, StackMob.config['production']['key'], StackMob.config['production']['secret'])
 
@@ -179,9 +179,6 @@ You can then proxy requests to your application using the `StackMob::Client#requ
 
     client.request(:get, :api, "heroku/proxy/path/to/proxy/to")
 
-## Running your Application Locally in Development
-
-
 
 ## Contributing to stackmob gem
 
@@ -189,13 +186,13 @@ The stackmob Ruby Gem is Apache 2.0 licensed (see LICENSE.txt) and we look forwa
 
 ### Reporting Bugs
 
-We are using [GitHub Issues](https://github.com/stackmob/stackmob-ruby/issues) to track feature requests and bugs.
+We are using <a href="https://github.com/stackmob/stackmob-ruby/issues">GitHub Issues</a> 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_URL="http://YOURDOMAIN.stackmob.com"
     export STACKMOB_TEST_KEY="YOUR TEST APP PUB KEY"
     export STACKMOB_TEST_SECRET="YOUR TEST APP PRIV KEY"
     

data/bin/stackmob

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'stackmob'
+
+StackMob::CLI::Main.start(ARGV)

data/lib/stackmob.rb

@@ -21,14 +21,31 @@ require 'stackmob/data_store'
 require 'stackmob/push'
 require 'stackmob/rack/simple_oauth_provider'
 require 'stackmob/helpers'
+require 'stackmob/cli/main'
 
 module StackMob
   
+  CONFIG_FILES = ["config/stackmob.yml",".stackmob"]
+
+  class ConfigurationError < RuntimeError; end
+    
+
   SANDBOX = 0
   PRODUCTION = 1
     
   def self.config
-    @config ||= YAML.load_file("config/stackmob.yml")
+    @config ||= load_config(CONFIG_FILES.clone)
+
+  end
+
+  def self.load_config(filenames)
+    YAML.load_file(filenames.shift)
+  rescue Errno::ENOENT    
+    if !filenames.empty? 
+      load_config(filenames) 
+    else
+      raise ConfigurationError.new("Missing configuration file (#{CONFIG_FILES.join(' or ')})")
+    end
   end
   
   def self.secret
@@ -47,8 +64,13 @@ module StackMob
     ENV['STACKMOB_CLIENT_NAME'] || StackMob.config['sm_client_name']
   end
 
-  def self.dev_url
-    "http://#{StackMob.client_name}.mob2.stackmob.com"
+  def self.dev_url    
+    if env_url = ENV['STACKMOB_DEV_URL']
+      env_url
+    else
+      cluster_name = (is_html5?) ?  "mob1" : "mob2"
+      "http://#{StackMob.client_name}.#{cluster_name}.stackmob.com"
+    end
   end
 
   def self.env
@@ -59,12 +81,16 @@ module StackMob
     env == PRODUCTION ? "production" : "development"
   end
 
+  def self.is_html5?
+    config['html5']
+  end
+
   def self.is_production?
     ENV["RACK_ENV"] == "production"
   end
 
   def self.sm_env_key_str(suffix)
-    "STACKMOB_" + ((is_production?) ? "PROD" : "SAND") + "_#{suffix.upcase}"
+    "STACKMOB_" + ((is_production?) ? "PROD" : "SAND") + "_#{suffix.to_s.upcase}"
   end
 
 

data/lib/stackmob/cli/local_server.rb

@@ -0,0 +1,60 @@
+# Copyright 2012 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.
+
+require 'rack'
+require 'stackmob/middleware/rewrite'
+require 'stackmob/middleware/proxy'
+
+begin
+  require 'thin/version'
+
+  module Thin::VERSION
+    # Censoring
+    if CODENAME == "Bat-Shit Crazy"
+      remove_const :CODENAME
+      CODENAME = "Rockhead Slate"
+    end
+  end
+rescue LoadError
+end
+
+module StackMob
+  module CLI
+    module LocalServer
+      DEFAULT_PORT = 4567
+
+      class Server < ::Rack::Server
+        def app
+          options[:app]
+        end      
+      end
+      
+      def start_local_server(port = DEFAULT_PORT, path_root = '.')
+        app = ::Rack::Builder.new do 
+          use StackMob::Middleware::Proxy
+          use StackMob::Middleware::Rewrite
+
+          endpoint = ::Rack::Static.new lambda { |e| [] }, :urls => ['/'], :root => path_root
+          map "/" do 
+            run endpoint
+          end
+        end.to_app        
+        Server.start :app => app, :host => '0.0.0.0', :server => 'thin', :Port => port
+      end
+      
+    end
+  end
+end
+
+

data/lib/stackmob/cli/main.rb

@@ -0,0 +1,33 @@
+# Copyright 2012 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.
+
+
+require 'thor'
+require 'stackmob/cli/local_server'
+
+module StackMob
+  module CLI    
+    class Main < Thor
+      include LocalServer
+
+      method_option "port", :type => :string, :banner => "port to start server on", :aliases => "-p", :default => "4567"
+      method_option "path", :type => :string, :banner => "root directory to serve files from", :default => "."
+      desc "server", "start test server"
+      def server
+        start_local_server(options[:port], options[:path])
+      end
+
+    end
+  end
+end

data/lib/stackmob/client.rb

@@ -33,18 +33,28 @@ module StackMob
       create_oauth_client(oauth_key, oauth_secret, base_url)
     end
 
-    def request(method, service, path, params = {})
-      request_path, request_body = generate_path_and_body(method, service, path, params)
+    def request(method, service, path, params = {}, raw = false, headers = {})
+      request_path, request_body = generate_path_and_body(method, service, path, params, raw)
+
+      args = [method, request_path]
+      if [:post, :put].include?(method)
+        headers.merge!("Content-Type" => "application/json") 
+        args << request_body << headers
+      else
+        args << headers
+      end
 
-      args = [method, request_path, request_body]
-      args << {"Content-Type" => "application/json"} if [:post, :put].include?(method)
       response = @oauth_client.send(*args)
 
-      rcode = response.code.to_i
-      if rcode >= 200 && rcode <= 299
-        parse_response(response) if method != :delete
+      if raw
+        response
       else
-        raise RequestError.new("\nReq Method: #{method}\nReq. Path: #{request_path}\nReq. Body: #{request_body}\nResp. Code: #{rcode}, Resp Body: #{response.respond_to?(:body) ? response.body : 'unknown'}")
+        rcode = response.code.to_i
+        if rcode >= 200 && rcode <= 299
+          parse_response(response) if method != :delete
+        else
+          raise RequestError.new("\nReq Method: #{method}\nReq. Path: #{request_path}\nReq. Body: #{request_body}\nResp. Code: #{rcode}, Resp Body: #{response.respond_to?(:body) ? response.body : 'unknown'}")
+        end
       end
     end
 
@@ -53,13 +63,13 @@ module StackMob
     end
     private :create_oauth_client
 
-    def generate_path_and_body(method, service, path, params)
+    def generate_path_and_body(method, service, path, params, raw)
       intermediate_path = full_path(service, path)
       case method
       when :get, :delete
-        [intermediate_path + "?" + params_to_qs(params), ""]
+        [intermediate_path + "?" + (raw ? params : params_to_qs(params)), ""]
       when :post, :put
-        [intermediate_path, Yajl::Encoder.encode(params)]
+        [intermediate_path, raw ? params : Yajl::Encoder.encode(params)]
       else
         raise InvalidRequestMethod
       end

data/lib/stackmob/middleware/proxy.rb

@@ -0,0 +1,68 @@
+# Copyright 2012 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.
+
+require 'rack'
+
+module StackMob
+  module Middleware
+    class Proxy
+      
+      HEADER_NAME = 'X-StackMob-Proxy'
+      RACK_ENV_NAME = 'HTTP_X_STACKMOB_PROXY'
+      VALID_HEADER_VALUES = ['stackmob-api']
+
+      EXCLUDED_HEADERS = ["VERSION", "DATE", "HOST"].map { |s| "HTTP_#{s}" }
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if VALID_HEADER_VALUES.include?(env[RACK_ENV_NAME])  
+          req = ::Rack::Request.new(env)
+          method = http_method(env)          
+          headers = http_headers(env)
+          params = [:put,:post].include?(method) ? req.body : req.query_string
+
+          response = client.request(method, :api, env['PATH_INFO'], params, true, headers)
+
+          [response.code.to_i, response.to_hash, response.body]
+        else
+          @app.call(env)
+        end
+      end
+
+      def client
+        @client ||= StackMob::Client.new(StackMob.dev_url, StackMob.app_name, StackMob::SANDBOX, StackMob.key, StackMob.secret)
+      end
+      private :client
+
+      def http_method(env)
+        env['REQUEST_METHOD'].downcase.to_sym
+      end
+
+      def http_headers(env)
+        headers = {}
+        for headerArr in env.select { |k, v| k.start_with? 'HTTP_' } 
+          if !EXCLUDED_HEADERS.include?(headerArr[0])
+            headers[headerArr[0].sub('HTTP_', '')] = headerArr[1]
+          end
+        end
+        headers["Accept"] = "application/json"
+        headers
+      end
+
+    end
+  end
+end

data/lib/stackmob/middleware/rewrite.rb

@@ -0,0 +1,50 @@
+# Copyright 2012 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.
+
+module StackMob
+  module Middleware
+    class Rewrite
+      def initialize(app)
+        @app = app
+      end
+      
+      def call(env)
+        status, hdrs, body = @app.call(env)
+        original_response = [status, hdrs, body]
+
+        if status == 404
+          path_info        = env['PATH_INFO']
+          env['PATH_INFO'] = "#{path_info}/index.html".gsub('//', '/')
+
+          
+          status, hdrs, body = @app.call(env)
+          
+          if status == 404
+            env['PATH_INFO'] = "/404.html"
+            
+            status, hdrs, body = @app.call(env)
+            
+            if status == 404
+              status, hdrs, body = original_response
+            else
+              status = 404
+            end
+          end
+        end
+        
+        [ status, hdrs, body ]
+      end
+    end
+  end
+end

data/lib/stackmob/tasks.rb

@@ -23,7 +23,7 @@ namespace :stackmob do
     abort("No Heroku App Name or Hostname Found in StackMob Config") if StackMob.config['heroku_app_name'].to_s.blank? && StackMob.config['heroku_hostname'].to_s.blank?
 
     hostname = StackMob.config['heroku_hostname'] || "#{StackMob.config['heroku_app_name']}.herokuapp.com"
-    client = StackMob::Client.new("http://#{StackMob.client_name}.mob2.stackmob.com", StackMob.app_name, StackMob::SANDBOX, StackMob.config['development']['key'], StackMob.config['development']['key'])
+    client = StackMob::Client.new("http://#{StackMob.client_name}.mob2.stackmob.com", StackMob.app_name, StackMob::SANDBOX, StackMob.config['development']['key'], StackMob.config['development']['secret'])
     deployer = StackMob::Deployer.new(client)
 
     begin

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - StackMob
@@ -15,11 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-12 00:00:00 Z
+date: 2012-02-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -30,12 +29,12 @@ dependencies:
         - 4
         - 5
         version: 0.4.5
-  version_requirements: *id001
-  name: oauth
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: *id001
   type: :runtime
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  name: oauth
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -46,26 +45,76 @@ dependencies:
         - 8
         - 2
         version: 0.8.2
-  version_requirements: *id002
+  prerelease: false
+  requirement: *id002
+  type: :runtime
   name: yajl-ruby
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 0
+        - 14
+        - 0
+        version: 0.14.0
   prerelease: false
+  requirement: *id003
+  type: :runtime
+  name: thor
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 31
         segments: 
+        - 1
+        - 2
         - 0
-        version: "0"
-  version_requirements: *id003
-  name: minitest
+        version: 1.2.0
   prerelease: false
+  requirement: *id004
+  type: :runtime
+  name: thin
 - !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  prerelease: false
+  requirement: *id005
+  type: :runtime
+  name: rack
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 11
+        - 0
+        version: 2.11.0
+  prerelease: false
+  requirement: *id006
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  name: minitest
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -76,12 +125,12 @@ dependencies:
         - 6
         - 0
         version: 0.6.0
-  version_requirements: *id004
-  name: yard
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: *id007
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  name: yard
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -90,12 +139,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id005
-  name: cucumber
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: *id008
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  name: cucumber
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -106,12 +155,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  version_requirements: *id006
-  name: bundler
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: *id009
   type: :development
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -122,12 +171,12 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  version_requirements: *id007
-  name: jeweler
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: *id010
   type: :development
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -136,12 +185,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id008
-  name: rcov
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: *id011
   type: :development
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  name: rcov
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -150,12 +199,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id009
-  name: mocha
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: *id012
   type: :development
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  name: mocha
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -164,12 +213,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id010
-  name: rack-test
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: *id013
   type: :development
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  name: rack-test
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -178,50 +227,54 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id011
+  prerelease: false
+  requirement: *id014
+  type: :development
   name: bluecloth
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id015 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 2
+        - 4
+        version: 2.2.4
   prerelease: false
+  requirement: *id015
+  type: :development
+  name: httpclient
 description: Support Gem for StackMob Heroku Add-On
 email: jordan@stackmob.com
-executables: []
-
+executables: 
+- stackmob
 extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
 - README.md
 files: 
-- .document
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- VERSION
 - lib/stackmob.rb
+- lib/stackmob/cli/local_server.rb
+- lib/stackmob/cli/main.rb
 - lib/stackmob/client.rb
 - lib/stackmob/data_store.rb
 - lib/stackmob/deployer.rb
 - lib/stackmob/helpers.rb
+- lib/stackmob/middleware/proxy.rb
+- lib/stackmob/middleware/rewrite.rb
 - lib/stackmob/push.rb
 - lib/stackmob/rack/simple_oauth_provider.rb
 - lib/stackmob/rails.rb
 - lib/stackmob/railtie.rb
 - lib/stackmob/sinatra.rb
 - lib/stackmob/tasks.rb
-- stackmob.gemspec
-- test/helper.rb
-- test/integration/test_client.rb
-- test/integration/test_data_store.rb
-- test/integration/test_deployer.rb
-- test/integration/test_push.rb
-- test/integration_helper.rb
-- test/unit/stackmob/rack/test_simple_oauth_provider.rb
-- 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/test_stackmob.rb
+- bin/stackmob
 homepage: http://github.com/stackmob/stackmob-ruby
 licenses: 
 - MIT
@@ -251,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Support Gem for StackMob Heroku Add-On