stackmob 0.0.0

data/Rakefile

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "stackmob"
+  gem.homepage = "http://github.com/stackmob/stackmob-ruby"
+  gem.license = "MIT"
+  gem.summary = "Support Gem for StackMob Heroku Add-On"
+  gem.description = "Support Gem for StackMob Heroku Add-On"
+  gem.email = "jordan@stackmob.com"
+  gem.authors = ["StackMob"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+require 'rcov/rcovtask'
+namespace :test do
+ 
+  
+  Rake::TestTask.new(:unit) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/unit/**/test_*.rb'
+    test.verbose = true
+  end		
+
+  Rake::TestTask.new(:integration) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/integration/**/test_*.rb'
+    test.verbose = true
+  end
+
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+    test.rcov_opts << '--exclude "gems/*"'
+  end
+
+  desc "Run Unit & Integration Tests"
+  task :all => [:unit, :integration]
+end
+
+task :default => "test:all"
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/stackmob.rb

@@ -0,0 +1,67 @@
+# 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.
+
+require 'oauth'
+require 'yajl'
+require 'yaml'
+
+require 'stackmob/client'
+require 'stackmob/data_store'
+require 'stackmob/push'
+require 'stackmob/rack/simple_oauth_provider'
+require 'stackmob/helpers'
+
+module StackMob
+  
+  SANDBOX = 0
+  PRODUCTION = 1
+    
+  def self.config
+    @config ||= YAML.load_file("config/stackmob.yml")
+  end
+  
+  def self.secret
+    StackMob.config[sm_env_str]['secret']
+  end
+
+  def self.key
+    StackMob.config[sm_env_str]['key']
+  end
+
+  def self.app_name
+    StackMob.config['sm_app_name']
+  end
+
+  def self.client_name
+    StackMob.config['sm_client_name']
+  end
+
+  def self.dev_url
+    "http://#{StackMob.client_name}.mob2.stackmob.com"
+  end
+
+  def self.env
+    (is_production?) ? PRODUCTION : SANDBOX
+  end
+
+  def self.sm_env_str
+    env == PRODUCTION ? "production" : "development"
+  end
+
+  def self.is_production?
+    ENV["RACK_ENV"] == "production"
+  end
+
+
+end

data/lib/stackmob/client.rb

@@ -0,0 +1,90 @@
+# 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.
+
+require 'oauth'
+require 'yajl'
+
+module StackMob
+  class Client        
+
+    VALID_METHODS = [:get, :post, :put, :delete]
+
+    class InvalidRequestMethod < ArgumentError; end # invalid HTTP Method/Verb is passed to the client
+    class RequestError < RuntimeError; end # response with code other than 200 received
+    class BadResponseBody < RuntimeError; end # Client receives response with invalid JSON    
+
+    attr_accessor :app_name, :app_vsn
+
+    def initialize(base_url, app_name, app_vsn, oauth_key, oauth_secret)
+      self.app_name = app_name
+      self.app_vsn = app_vsn
+
+      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)
+
+      response = @oauth_client.send(method, request_path, request_body)
+
+      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
+
+    def create_oauth_client(key, secret, url)
+      @oauth_client = OAuth::AccessToken.new(OAuth::Consumer.new(key, secret, :site => url))
+    end
+    private :create_oauth_client
+
+    def generate_path_and_body(method, service, path, params)
+      intermediate_path = full_path(service, path)
+      case method
+      when :get, :delete
+        [intermediate_path + "?" + params_to_qs(params), ""]
+      when :post, :put
+        [intermediate_path, Yajl::Encoder.encode(params)]
+      else
+        raise InvalidRequestMethod
+      end
+    end
+    private :generate_path_and_body
+
+    def params_to_qs(params)
+      params.to_a.map { |pair| pair.join("=") }.join("&")
+    end
+    private :params_to_qs
+
+    def parse_response(r)
+      Yajl::Parser.parse(r.body)
+    rescue Yajl::ParseError
+      raise BadResponseBody.new("#{r.body} is not valid JSON")
+    end
+    private :parse_response
+
+    def full_path(service, requested_path)
+      "/#{service}/#{self.app_vsn}/#{self.app_name}/#{strip_prepending_slash(requested_path)}"
+    end
+    private :full_path
+
+    def strip_prepending_slash(path)
+      path.gsub(/^\//, "")
+    end
+    private :strip_prepending_slash
+
+  end
+end

data/lib/stackmob/data_store.rb

@@ -0,0 +1,74 @@
+# 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.
+
+module StackMob
+  class DataStore      
+
+    attr_accessor :client
+
+    API_SVC = :api
+
+    def initialize(cl)
+      self.client = cl
+    end
+
+    def api_schema
+      self.client.request(:get, API_SVC, "/listapi")
+    end
+    
+    def create(obj_name, params)
+      create!(obj_name, params)
+    rescue Client::RequestError
+      false
+    end
+
+    def create!(obj_name, params)
+      self.client.request(:post, API_SVC, obj_name_to_path(obj_name), params)
+    end
+
+    def delete(obj_name, params)
+      delete!(obj_name, params); true
+    rescue Client::RequestError
+      false
+    end
+
+    def delete!(obj_name, params)
+      self.client.request(:delete, API_SVC, obj_name_to_path(obj_name), params)
+    end
+
+    def get(obj_name, params = {})
+      self.client.request(:get, API_SVC, obj_name_to_path(obj_name), params)
+    end
+
+    def get_one(obj_name, params)
+      get(obj_name, params).first
+    end
+
+    def update(obj_name, obj_id, params)
+      update!(obj_name, obj_id, params); true
+    rescue Client::RequestError
+      false
+    end
+
+    def update!(obj_name, obj_id, params)
+      self.client.request(:put, API_SVC, obj_name_to_path(obj_name) + "/#{obj_id}", params)
+    end
+
+    def obj_name_to_path(obj_name)
+      "/#{obj_name}"
+    end
+    private :obj_name_to_path
+
+  end
+end

data/lib/stackmob/deployer.rb

@@ -0,0 +1,37 @@
+# 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.
+
+require 'stackmob' 
+
+module StackMob
+  class Deployer
+    
+    attr_accessor :client
+
+    APP_PATH = "heroku/app"
+
+    def initialize(cl)
+      self.client = cl
+    end
+
+    def register(hostname)
+      self.client.request(:post, :api, APP_PATH, :hostname => hostname)
+    end
+
+    def fetch
+      self.client.request(:get, :api, APP_PATH)
+    end
+
+  end
+end

data/lib/stackmob/helpers.rb

@@ -0,0 +1,63 @@
+# 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.
+
+module StackMob
+  module Helpers
+    def sm_datastore
+      @sm_datastore ||= begin
+                          client = StackMob::Client.new(sm_api_host, sm_app_name, StackMob.env, StackMob.key, StackMob.secret)
+                          StackMob::DataStore.new(client)
+                        end
+    end
+    
+    def sm_push
+      @sm_push ||= begin
+                     client = StackMob::Client.new(sm_push_host, sm_app_name, StackMob.env, StackMob.key, StackMob.secret)
+                     StackMob::Push.new(client)
+                   end
+    end
+    
+    def sm_api_host
+      sm_normalize_host(sm_hostname_from_header_or_config('HTTP_X_STACKMOB_API'))
+    end
+    private :sm_api_host
+
+    def sm_push_host
+      sm_normalize_host(sm_hostname_from_header_or_config('HTTP_X_STACKMOB_PUSH'))
+    end
+    private :sm_push_host
+    
+    def sm_hostname_from_header_or_config(header_str)
+      hostname = request.env[header_str]
+      (hostname.nil? || hostname == "") ? StackMob.dev_url : hostname
+    end
+    private :sm_hostname_from_header_or_config
+
+    def sm_app_name
+      StackMob.app_name
+    end
+    private :sm_app_name
+    
+    def sm_app_version
+      (Rails.env.production?) ? StackMob::PRODUCTION : StackMob::SANDBOX
+    end
+    private :sm_app_version
+    
+    def sm_normalize_host(host_str)
+      "http://#{StackMob.client_name}.#{host_str}"
+    end
+    private :sm_normalize_host
+
+  end
+end

data/lib/stackmob/push.rb

@@ -0,0 +1,63 @@
+# 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.
+
+module StackMob
+  class Push
+    
+    attr_accessor :client
+
+    PUSH_SVC = :push
+    DEVICE_TOKEN_PATH = "/device_tokens"
+    BROADCAST_PATH = "/push_broadcast"
+    PUSH_PATH = "/push"
+
+    DEFAULT_BADGE = 0
+    DEFAULT_SOUND = ""
+
+    def initialize(cl)
+      self.client = cl
+    end
+
+    def register(user_id, device_token)
+      self.client.request(:post, PUSH_SVC, DEVICE_TOKEN_PATH, :userId => user_id, :token => device_token) # using non-convential symbols to conform to StackMob Push API
+    end
+
+    def broadcast(opts)
+      aps_data = generate_aps_data(opts)
+      payload = {:recipients => [], :aps => aps_data, :areRecipientsDeviceTokens => true, :exclude_tokens => []}
+
+      self.client.request(:post, PUSH_SVC, BROADCAST_PATH, payload)
+    end
+
+    def send_message(to, opts)
+      aps_data = generate_aps_data(opts)
+      recipients_are_device_tokens = (opts[:recipients_are_users]) ? false : true
+      payload = {:recipients => Array(to), :aps => aps_data, :areRecipientsDeviceTokens => recipients_are_device_tokens, :exclude_tokens => []}
+
+      self.client.request(:post, PUSH_SVC, PUSH_PATH, payload)
+    end
+
+    def generate_aps_data(opts)
+      alert = opts[:alert] || (raise ArgumentError.new("Push requires alert message"))
+      badge = opts[:badge] || DEFAULT_BADGE
+      sound = opts[:sound] || DEFAULT_SOUND
+      
+      {:badge => badge, :sound => sound, :alert => alert}
+    end
+    private :generate_aps_data
+
+    
+
+  end
+end