restpack_web 0.0.5 → 0.2.17

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 8830af231f1d83fb48ceae33fd6e664421a7decd
-  data.tar.gz: f6a3bfb0fc99b289934bc476abb95c0b0b573663
-SHA512:
-  metadata.gz: fda6cf1ebece0df58b0b0aeadb91b4680c905686bd6d5fc86466c89a605b9f23c7c373cddd302eb7e97d7b69a0a2b344defda1157359f41629d9f8c2b32d3dda
-  data.tar.gz: 66f2cd98d722c66ab32b4c59ed5a5fc2b1b12553b1b29455b963e343d7a0178bad5071af552b830640cbc16dc551a9d9d86b942d5ac7a155c49e4dfd145a95fb
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmM0NmRhNjIyNjI2MzMzNTkzMmNkZDAzZTk5ZTJmYzk3OWY2NDhjZA==
+  data.tar.gz: !binary |-
+    ZDUxNjQyMzE0M2FhODlkM2Y2MDRiZGRlNzYxNThjZDQ2Mzg0ZjlhZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YjkxMWE1MTlkYjg0YTIyYWUyMTRlZGIyMGNmMmY2N2EwNzE2M2Y0MDdhYWMy
+    MTNkYWVlNjE3MTQ2Mjk2ODYwM2NiMTdiZDVjOWY1ZWI0ZjQ0YTU4MTQyZGM1
+    YjdhN2QzNjY4M2VkN2EwMjNiZjExNzQxMjk4NmEyYzA2NDc4MWQ=
+  data.tar.gz: !binary |-
+    MzU2ZGFjZDU4Mzc5NDk3ZDc5ZGZjM2RmZGMwOTUwNGQxOWNjMzA3MWUzOGEy
+    OTQ3MzgyYzY5NWQ4YTk4MWI4MTc3YzUyNTVhMWZmMGQxN2M4Mjc1NjIxNGQ4
+    YmNhZWI1MjJhNDY4ZjUzYzJlMzE2MWI2ZmVjYzYwMDg4ODYyM2M=

data/.gitignore

@@ -14,4 +14,4 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
-tmp
+tmp

data/Gemfile

@@ -1,5 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'encrypted_cookie', path: '../encrypted_cookie'

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+-----------
+
+Copyright (c) 2013 Gavin Joyce and RestPack contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,3 +1,30 @@
-# restpack_web
+## Install in Rails 3
+Add `restpack-web` to Gemfile
+```ruby
+gem 'restpack-web', '~> 0.2.16', :git => 'git://github.com/RestPack/restpack-web.git'
+```
+
+Use `RestPack::Web::App` as a middleware in `application.rb`
+```ruby
+config.middleware.use RestPack::Web::App
+```
+
+Set necessary environment variables:
+```ruby
+ENV['RESTPACK_ACCESS_KEY'] = 'secret'
+ENV['RESTPACK_CORE_SERVICE'] = 'restpack-core-service.restpack.org'
+```
+
+## Testing your app
+You can stub all requests from restpack_web to the core service.
+```ruby
+require 'restpack_web/test_support'
+RestPack::Web::TestSupport.stub_restpack_web
+```
+
+## Testing
+`bundle exec rake test`
+
+## Bump to a new version
+`bundle exec bump patch && rake tag`
 
-Rack middleware for your RestPack web apps

data/Rakefile

@@ -1,2 +1,39 @@
-require "restpack_gem"
-RestPack::Gem::Tasks.load_tasks
+require 'bundler/setup'
+require 'rake/testtask'
+require 'bump/tasks'
+require_relative 'lib/restpack_web/version'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :gem do
+  ["gem:bump", "gem:tag", "gem:build", "gem:push"].each do |task|
+    Rake::Task[task].reenable
+    Rake::Task[task].invoke
+  end
+end
+
+namespace :gem do
+  task :build do
+    sh "gem build restpack_web.gemspec"
+  end
+
+  task :push do
+    require 'bump'
+    sh "gem push restpack_web-#{Bump::Bump.current}.gem"
+  end
+
+  task :tag do
+    require 'bump'
+    version = Bump::Bump.current
+    puts "tagging v#{version}"
+    `git push && git tag v#{version} && git push --tags`
+  end
+
+  task :bump do
+    Rake::Task["bump:patch"].invoke
+  end
+end

data/lib/restpack_web/app.rb

@@ -0,0 +1,67 @@
+require 'restpack_core_client'
+
+module RestPack
+  module Web
+    class App
+      def initialize(app, options = {})
+        p "RestPack::Web::App.initialize"
+        @app = app
+
+        options[:core_domain] ||= ENV['RESTPACK_CORE_SERVICE']
+        options[:access_key] ||= ENV['RESTPACK_ACCESS_KEY']
+
+        raise "missing RestPack configuration" unless options[:core_domain] || options[:access_key]
+
+        @core_cache = RestPack::Core::Client::Cache.create(options[:core_domain], options[:access_key])
+      end
+
+      def call(env)
+        env[:restpack] ||= {}
+
+        begin #TODO: GJ: cache should handle errors gracefully
+          request = Rack::Request.new(env)
+
+          channel = @core_cache.get_channel(request.host)
+          domain = channel.get_domain_by_host(request.host)
+
+          env[:restpack][:request] = request
+          env[:restpack][:host] = request.host
+          env[:restpack][:channel] = channel
+          env[:restpack][:application] = domain.application
+          env[:restpack][:domain] = domain
+          env[:restpack][:configurations] = @core_cache.configurations
+          env[:restpack][:services] = @core_cache.get_configuration_value('services', [])
+
+          add_user env
+
+        rescue Exception => e
+          p "---"
+          p e.message
+          p "===="
+          p e.backtrace.inspect
+          p "---"
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def add_user(env)
+        return unless env['rack.session']
+
+        user_id = env['rack.session'][:user_id]
+
+        if user_id
+          user_id = env['rack.session'][:user_id]
+          channel_domains = env[:restpack][:channel].configurations.find{ |conf| conf.key == 'domains' }.value
+          auth_domain = channel_domains[:auth]
+          json = RestClient.get("#{auth_domain}/api/v1/users/#{user_id}.json")
+          env[:restpack][:user] = Yajl::Parser.parse(json)['user']
+        end
+
+        env[:restpack][:user_id] = user_id
+      end
+    end
+  end
+end

data/lib/restpack_web/context.rb

@@ -1,70 +1,107 @@
-module RestPack::Web
-  class Context
-    attr_accessor :domain, :application, :user, :account
-
-    def initialize(env)
-      restpack = env['restpack']
-
-      if restpack
-        @domain = restpack[:domain]
-        @application = restpack[:application]
-        @user = restpack[:user]
-        @account = restpack[:account]
+require 'public_suffix'
+
+module RestPack
+  module Web
+    class Context
+      attr_accessor :domain, :application, :channel, :configurations, :services, :user, :user_id, :request
+      
+      def initialize(env)    
+        restpack = env[:restpack]
+
+        if restpack
+          @request = restpack[:request]
+          @domain = restpack[:domain]
+          @application = restpack[:application]
+          @channel = restpack[:channel]
+          @configurations = restpack[:configurations]
+          @services = restpack[:services]
+          @user = restpack[:user]
+          @user_id = @user[:id] if @user
+        end
       end
-    end
 
-    def authenticated?
-      !@user.nil?
-    end
+      def is_authenticated?
+        !@user.nil?
+      end
 
-    def user_id
-      authenticated? ? @user[:id] : nil
-    end
+      def get_service(name)
+        @services.find { |s| s[:name] == name.to_s }
+      end
 
-    def account_id
-      authenticated? ? @account[:id] : nil
-    end
+      def home_domain
+        @application.home_domain || "www.#{root_domain}"
+      end
 
-    def application_id
-      @application[:id]
-    end
+      def auth_domain
+        @application.auth_domain || "auth.#{root_domain}"
+      end
 
-    def domain_id
-      @domain[:id]
-    end
+      def root_domain
+        PublicSuffix.parse(@domain.host).domain
+      end
 
-    def home_domain
-      "www.#{@domain[:identifier]}"
-    end
+      def logout_url(next_url = nil) #TODO: GJ: whitelist the next_url
+        next_url ||= "http://#{home_domain}/"
+        "http://#{auth_domain}/auth/logout?next=#{next_url}"
+      end
 
-    def auth_domain
-      "auth.#{@domain[:identifier]}"
-    end
+      def login_url(provider = :twitter, next_url = nil)
+        next_url ||= "http://#{home_domain}/"
+        "http://#{auth_domain}/auth/#{provider}?next=#{next_url}"
+      end
 
-    def logout_url(next_url = nil)
-      next_url ||= "http://#{home_domain}/"
-      auth_url('/auth/logout', next_url)
-    end
+      def debug_info #TODO: GJ: move to a mixin
+        user_debug_info = ""
+        if is_authenticated?
+          image_debug_info = ""
+          image_debug_info = " * **image** : #{@user['image']} ![Image](#{@user['image']}" unless @user['image'].nil?
 
-    def login_url(provider = :twitter, next_url = nil)
-      auth_url("/auth/#{provider}", next_url)
-    end
+          user_debug_info = %{
+ * **id** : #{@user['id']}
+ * **name** : #{@user['name']}
+ * **nickname** : #{@user['nickname']}
+ * **location** : #{@user['location']}
+ * **description** : #{@user['description']}
+#{image_debug_info})
+          }
+        end
 
-    def debug_info
-      "todo"
-    end
+        %{
+### RestPack Context:
+
+#### User:
+
+ * **is authenticated**: #{is_authenticated?}
+#{user_debug_info}
+
+#### Channel:
 
-    private
+ * **id**: #{@channel.id}
+ * **name**: #{@channel.name}
+ * **applications**: #{@channel.applications.map { |a| a.name }.join(', ')}
 
-    def auth_url(path, next_url = nil)
-      #TODO: GJ: whitelist the next_url?
-      #TODO: GJ: URI encode next_url?
-      port = RestPack::Web.config.authentication_port
+#### Application:
 
-      port_part = port ? ":#{port}" : ""
-      next_part = next_url ? "?next=#{next_url}" : ""
+ * **id**: #{@application.id}
+ * **name**: #{@application.name}
+ * **domains**: #{@application.domains.map { |a| a.host }.join(', ')}
 
-      "http://#{auth_domain}#{port_part}#{path}#{next_part}"
+#### Domain:
+
+ * **id**: #{@domain.id}
+ * **host**: #{@domain.host}
+
+#### Configuration:
+
+ * **keys**: #{@configurations.map { |c| c.key }.join(', ')}
+
+#### Authentication:
+
+ * **logout**: #{logout_url}
+ * **twitter oauth**: #{login_url(:twitter)}
+ * **google oauth**: #{login_url(:google_oauth2)}
+          }
+      end
     end
   end
-end
+end

data/lib/restpack_web/rails/controller.rb

@@ -1,11 +1,15 @@
-module RestPack::Web::Rails
-  module Controller
-    def self.included(base)
-      base.send(:before_filter, :setup_restpack_context)
-    end
-
-    def setup_restpack_context
-      @restpack = RestPack::Web::Context.new(request.env)
+module RestPack
+  module Web
+    module Rails
+      module Controller
+        def self.included(base)
+          base.send(:before_filter, :include_restpack)
+        end
+  
+        def include_restpack
+          @restpack = RestPack::Web::Context.new(request.env)
+        end
+      end
     end
   end
-end
+end

data/lib/restpack_web/sinatra/app.rb

@@ -1,13 +1,20 @@
-module RestPack::Web::Sinatra
-  module App
-    def self.included(base)
-      base.use RestPack::Web::Rack::Domain
-      base.use RestPack::Web::Rack::Session
-      base.use RestPack::Web::Rack::User
+require 'rack-auto-session-domain'
 
-      base.before do
-        @restpack = RestPack::Web::Context.new(env)
+module RestPack
+  module Web
+    module Sinatra
+      module App
+        def self.included(base)
+          base.use Rack::AutoSessionDomain
+          base.use RestPack::Web::App
+          base.enable :sessions
+          base.set :session_secret, 'c40b83f9048c497891f0f71e4b040a3f' #TODO: GJ: from restpack config
+
+          base.before do
+            @restpack = RestPack::Web::Context.new(env)
+          end
+        end
       end
     end
   end
-end
+end

data/lib/restpack_web/test_support.rb

@@ -0,0 +1,26 @@
+require 'webmock'
+include WebMock::API
+
+module Rack
+  module Test
+    DEFAULT_HOST = 'sinatra.restpack-sample.org'
+  end
+end
+
+module RestPack
+  module Web
+    class TestSupport
+      def self.stub_restpack_web
+        host = "http://:#{ENV['RESTPACK_ACCESS_KEY']}@#{ENV['RESTPACK_CORE_SERVICE']}/api/v1"
+        stub_request(:get, "#{host}/configurations/root.json").to_return(:body => read_fixture('configurations_root'))
+        stub_request(:get, "#{host}/domains/search.json?host=sinatra.restpack-sample.org").to_return(:body => read_fixture('domains_search'))
+        stub_request(:get, "#{host}/channels/1.json").to_return(:body => read_fixture('channels'))
+      end
+
+      def self.read_fixture(name)
+        file = File.open("#{File.expand_path('../../../spec/fixtures', __FILE__)}/#{name}.json")
+        file.read
+      end
+    end
+  end
+end

data/lib/restpack_web/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Web
-    VERSION = "0.0.5"
+    VERSION = "0.2.17"
   end
-end
+end

data/lib/restpack_web.rb

@@ -1,11 +1,6 @@
 require 'restpack_web/version'
-
-require 'restpack_web/configuration'
 require 'restpack_web/context'
-
-require 'restpack_web/rack/domain'
-require 'restpack_web/rack/user'
-require 'restpack_web/rack/session'
+require 'restpack_web/app'
 
 require 'restpack_web/rails/controller'
 require 'restpack_web/sinatra/app'

data/restpack_web.gemspec

@@ -1,31 +1,32 @@
-# coding: utf-8
+# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'restpack_web/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "restpack_web"
-  spec.version       = RestPack::Web::VERSION
-  spec.authors       = ["Gavin Joyce"]
-  spec.email         = ["gavinjoyce@gmail.com"]
-  spec.description   = %q{Rack middleware for your RestPack web apps}
-  spec.summary       = %q{Rack middleware}
-  spec.homepage      = "http://restpack.org/"
-  spec.license       = "MIT"
+Gem::Specification.new do |gem|
+  gem.name          = "restpack_web"
+  gem.version       = RestPack::Web::VERSION
+  gem.authors       = ["Gavin Joyce"]
+  gem.email         = ["gavinjoyce@gmail.com"]
+  gem.description   = %q{Run a web application on RestPack}
+  gem.summary       = %q{Run a web application on RestPack}
+  gem.homepage      = "https://github.com/RestPack"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
 
-  spec.add_dependency "restpack_gem"
-  spec.add_dependency "restpack_core_service"
-  spec.add_dependency "restpack_user_service"
-  spec.add_dependency "restpack_account_service"
-  spec.add_dependency "restpack_group_service"
+  gem.add_dependency 'rack-auto-session-domain', '~> 0.1.1'
+  gem.add_dependency 'restpack_core_client', '~> 0.2.2'
+  gem.add_dependency 'public_suffix', '~> 1.3.0'
+  gem.add_dependency 'yajl-ruby', '~> 1.1.0'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "bump"
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rack'
+  gem.add_development_dependency 'bump', '~> 0.4'
+  gem.add_development_dependency 'minitest', '~> 4.7'
+  gem.add_development_dependency 'rack-test', '~> 0.6'
+  gem.add_development_dependency 'webmock', '~> 1.11'
+  gem.add_development_dependency 'rest-client'
 end