RubyGems - cloudkit-jruby - Versions diffs - 0.11.2 - Mend

cloudkit-jruby 0.11.2

Files changed (64) hide show

data/CHANGES +47 -0
data/COPYING +20 -0
data/README +84 -0
data/Rakefile +42 -0
data/TODO +21 -0
data/cloudkit.gemspec +89 -0
data/doc/curl.html +388 -0
data/doc/images/example-code.gif +0 -0
data/doc/images/json-title.gif +0 -0
data/doc/images/oauth-discovery-logo.gif +0 -0
data/doc/images/openid-logo.gif +0 -0
data/doc/index.html +90 -0
data/doc/main.css +151 -0
data/doc/rest-api.html +467 -0
data/examples/1.ru +3 -0
data/examples/2.ru +3 -0
data/examples/3.ru +6 -0
data/examples/4.ru +5 -0
data/examples/5.ru +9 -0
data/examples/6.ru +11 -0
data/examples/TOC +17 -0
data/lib/cloudkit.rb +92 -0
data/lib/cloudkit/constants.rb +34 -0
data/lib/cloudkit/exceptions.rb +10 -0
data/lib/cloudkit/flash_session.rb +20 -0
data/lib/cloudkit/oauth_filter.rb +266 -0
data/lib/cloudkit/oauth_store.rb +48 -0
data/lib/cloudkit/openid_filter.rb +236 -0
data/lib/cloudkit/openid_store.rb +100 -0
data/lib/cloudkit/rack/builder.rb +120 -0
data/lib/cloudkit/rack/router.rb +20 -0
data/lib/cloudkit/request.rb +177 -0
data/lib/cloudkit/service.rb +162 -0
data/lib/cloudkit/store.rb +349 -0
data/lib/cloudkit/store/memory_table.rb +99 -0
data/lib/cloudkit/store/resource.rb +269 -0
data/lib/cloudkit/store/response.rb +52 -0
data/lib/cloudkit/store/response_helpers.rb +84 -0
data/lib/cloudkit/templates/authorize_request_token.erb +19 -0
data/lib/cloudkit/templates/oauth_descriptor.erb +43 -0
data/lib/cloudkit/templates/oauth_meta.erb +8 -0
data/lib/cloudkit/templates/openid_login.erb +31 -0
data/lib/cloudkit/templates/request_authorization.erb +23 -0
data/lib/cloudkit/templates/request_token_denied.erb +18 -0
data/lib/cloudkit/uri.rb +88 -0
data/lib/cloudkit/user_store.rb +37 -0
data/lib/cloudkit/util.rb +25 -0
data/spec/ext_spec.rb +76 -0
data/spec/flash_session_spec.rb +20 -0
data/spec/memory_table_spec.rb +86 -0
data/spec/oauth_filter_spec.rb +326 -0
data/spec/oauth_store_spec.rb +10 -0
data/spec/openid_filter_spec.rb +81 -0
data/spec/openid_store_spec.rb +101 -0
data/spec/rack_builder_spec.rb +39 -0
data/spec/request_spec.rb +191 -0
data/spec/resource_spec.rb +310 -0
data/spec/service_spec.rb +1039 -0
data/spec/spec_helper.rb +32 -0
data/spec/store_spec.rb +10 -0
data/spec/uri_spec.rb +93 -0
data/spec/user_store_spec.rb +10 -0
data/spec/util_spec.rb +11 -0
metadata +180 -0

data/lib/cloudkit/templates/authorize_request_token.erb ADDED

@@ -0,0 +1,19 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+  <title>OAuth Request Token Authorized</title>
+  <style type="text/css">
+    body {
+      font-family: 'Helvetica', 'Arial', san-serif;
+    }
+  </style>
+</head>
+<body>
+<p>
+  Your OAuth Request Token has been authorized. Please return to the application
+  that initiated this request to complete the setup.
+</p>
+</body>
+</html>

data/lib/cloudkit/templates/oauth_descriptor.erb ADDED

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<XRDS xmlns="xri://$xrds">
+  <XRD xml:id="oauth" xmlns:simple="http://xrds-simple.net/core/1.0" xmlns="xri://$XRD*($v*2.0)" version="2.0">
+    <Type>xri://$xrds*simple</Type>
+    <Expires><%= Time.at(Time.now.to_i + 2592000).utc.xmlschema %></Expires>
+    <Service priority="10">
+      <Type>http://oauth.net/core/1.0/endpoint/request</Type>
+      <Type>http://oauth.net/core/1.0/parameters/auth-header</Type>
+      <Type>http://oauth.net/core/1.0/parameters/uri-query</Type>
+      <Type>http://oauth.net/core/1.0/signature/PLAINTEXT</Type>
+      <URI><%= request.scheme %>://<%= request.env['HTTP_HOST'] %>/oauth/request_tokens</URI>
+    </Service>
+    <Service priority="10">
+      <Type>http://oauth.net/core/1.0/endpoint/authorize</Type>
+      <Type>http://oauth.net/core/1.0/parameters/uri-query</Type>
+      <URI><%= request.scheme %>://<%= request.env['HTTP_HOST'] %>/oauth/authorization</URI>
+    </Service>
+    <Service priority="10">
+      <Type>http://oauth.net/core/1.0/endpoint/access</Type>
+      <Type>http://oauth.net/core/1.0/parameters/auth-header</Type>
+      <Type>http://oauth.net/core/1.0/parameters/uri-query</Type>
+      <Type>http://oauth.net/core/1.0/signature/PLAINTEXT</Type>
+      <URI><%= request.scheme %>://<%= request.env['HTTP_HOST'] %>/oauth/access_tokens</URI>
+    </Service>
+    <Service priority="10">
+      <Type>http://oauth.net/core/1.0/endpoint/resource</Type>
+      <Type>http://oauth.net/core/1.0/parameters/auth-header</Type>
+      <Type>http://oauth.net/core/1.0/parameters/uri-query</Type>
+      <Type>http://oauth.net/core/1.0/signature/HMAC-SHA1</Type>
+    </Service>
+    <Service priority="10">
+      <Type>http://oauth.net/discovery/1.0/consumer-identity/static</Type>
+      <LocalID>cloudkitconsumer</LocalID>
+    </Service>
+  </XRD>
+  <XRD xmlns="xri://$XRD*($v*2.0)" version="2.0">
+    <Type>xri://$xrds*simple</Type>
+    <Service priority="10">
+      <Type>http://oauth.net/discovery/1.0</Type>
+      <URI>#oauth</URI>
+    </Service>
+  </XRD>
+</XRDS>

data/lib/cloudkit/templates/oauth_meta.erb ADDED

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<XRD>
+  <Type>http://oauth.net/discovery/1.0</Type>
+  <Service>
+    <Type>http://oauth.net/discovery/1.0/rel/provider</Type>
+    <URI><%= request.scheme %>://<%= request.env['HTTP_HOST'] %>/oauth</URI>
+  </Service>
+</XRD>

data/lib/cloudkit/templates/openid_login.erb ADDED

@@ -0,0 +1,31 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+  <title>Sign Up or Sign In</title>
+  <style type="text/css">
+    body {
+      font-family: 'Helvetica', 'Arial', san-serif;
+    }
+    #openid_url {
+      background: url(data:image/gif;base64,R0lGODlhEAAQANUAAPr6+t/f37Gxsby8vJycnKWlpaampq+vr/zUpfz8/Lm5ufLy8r6+vp2dncvLy/muVsjIyLW1tcTExKGhof7+/sDAwMHBwbS0tNnZ2erq6qioqPn5+bi4uLu7u+np6e3t7evr66mpqeXl5b29vaqqqtfX18zMzO7u7u/v756enveTHv///wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAAAAAAALAAAAAAQABAAAAZlwJVwKEQQj0eECslcqZbN4zMqhTY/EoFzKbCAVoDNKjFIERTbFaeRcpwWCU3qgBJOVxVDhOEpH4hTFBkBIyQiKSkBgFZEiBiLTBApBgBDd0gXKROKaU0mZiEFl0wAJR0FD1SqQ0EAOw%3D%3D) no-repeat #FFF 5px;
+      padding-left: 25px;
+      width: 300px;
+    }
+    #submit {
+      display: block;
+      margin-top: 10px;
+    }
+  </style>
+</head>
+<body>
+<%= request.flash[:error] %>
+<%= request.flash[:info] %>
+<p>Sign Up or Sign In with OpenID</p>
+<form action="/login" method="POST">
+<input type="text" id="openid_url" name="openid_url"/>
+<input id="submit" type="submit" value="Sign In"/>
+</form>
+</body>
+</html>

data/lib/cloudkit/templates/request_authorization.erb ADDED

@@ -0,0 +1,23 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+  <title>OAuth Authorization Requested</title>
+  <style type="text/css">
+    body {
+      font-family: 'Helvetica', 'Arial', san-serif;
+    }
+  </style>
+</head>
+<body>
+<p>
+  Another application or website has requested access to your data.
+</p>
+<form action="/oauth/authorized_request_tokens/<%= request['oauth_token'] %>" method="POST">
+  <input type="hidden" name="_method" value="PUT"/>
+  <input type="submit" value="Approve"/>
+  <input type="submit" value="Deny"/>
+</form>
+</body>
+</html>

data/lib/cloudkit/templates/request_token_denied.erb ADDED

@@ -0,0 +1,18 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+  <title>OAuth Request Token Authorization Denied</title>
+  <style type="text/css">
+    body {
+      font-family: 'Helvetica', 'Arial', san-serif;
+    }
+  </style>
+</head>
+<body>
+<p>
+  Your OAuth Request Token was not denied and has been removed.
+</p>
+</body>
+</html>

data/lib/cloudkit/uri.rb ADDED

@@ -0,0 +1,88 @@
+module CloudKit
+  # A CloudKit::URI wraps a URI string, adding methods useful for routing
+  # in CloudKit as well as caching URI components for future comparisons.
+  class URI
+    # The string form of a URI.
+    attr_reader :string
+    # Create a new URI with the given string.
+    def initialize(string)
+      @string = string
+    end
+    # Return the resource collection URI fragment.
+    #   Example: URI.new('/foos/123').collection_uri_fragment => '/foos
+    def collection_uri_fragment
+      "/#{components[0]}" rescue nil
+    end
+    # Splits a URI into its components
+    def components
+      @components ||= @string.split('/').reject{|x| x == '' || x == nil} rescue []
+    end
+    # Return the resource collection referenced by a URI.
+    #   Example: URI.new('/foos/123').collection_type => :foos
+    def collection_type
+      components[0].to_sym rescue nil
+    end
+    # Return the URI for the current version of a resource.
+    #   Example: URI.new('/foos/123/versions/abc').current_resource_uri => '/foos/123'
+    def current_resource_uri
+      "/#{components[0..1].join('/')}" rescue nil
+    end
+    # Returns true if URI matches /cloudkit-meta
+    def meta_uri?
+      return components.size == 1 && components[0] == 'cloudkit-meta'
+    end
+    # Returns true if URI matches /{collection}
+    def resource_collection_uri?
+      return components.size == 1 && components[0] != 'cloudkit-meta'
+    end
+    # Returns true if URI matches /{collection}/_resolved
+    def resolved_resource_collection_uri?
+      return components.size == 2 && components[1] == '_resolved'
+    end
+    # Returns true if URI matches /{collection}/{uuid}
+    def resource_uri?
+      return components.size == 2 && components[1] != '_resolved'
+    end
+    # Returns true if URI matches /{collection}/{uuid}/versions
+    def version_collection_uri?
+      return components.size == 3 && components[2] == 'versions'
+    end
+    # Returns true if URI matches /{collection}/{uuid}/versions/_resolved
+    def resolved_version_collection_uri?
+      return components.size == 4 && components[2] == 'versions' && components[3] == '_resolved'
+    end
+    # Returns true if URI matches /{collection}/{uuid}/versions/{etag}
+    def resource_version_uri?
+      return components.size == 4 && components[2] == 'versions' && components[3] != '_resolved'
+    end
+    # Returns a cannonical URI for a given URI/URI fragment, generating it if
+    # required.
+    #   Example: URI.new('/items/123').cannoncal_uri_string => /items/123
+    #
+    #   Example: URI.new('/items').cannonical_uri_string => /items/some-new-uuid
+    def cannonical_uri_string
+      @cannonical_uri_string ||= if resource_collection_uri?
+        "#{@string}/#{UUID.generate}"
+      elsif resource_uri?
+        @string
+      else
+        raise CloudKit::InvalidURIFormat
+      end
+    end
+  end
+end

data/lib/cloudkit/user_store.rb ADDED

@@ -0,0 +1,37 @@
+module CloudKit
+  # A thin layer on top of CloudKit::Store providing consistent URIs and
+  # automatic upgrades if required for future releases.
+  class UserStore
+    @@store = nil
+    def initialize(uri=nil)
+      unless @@store
+        @@store = Store.new(:collections => [:cloudkit_users])
+      end
+    end
+    def get(uri, options={}) #:nodoc:
+      @@store.get(CloudKit::URI.new(uri), options)
+    end
+    def post(uri, options={}) #:nodoc:
+      @@store.post(CloudKit::URI.new(uri), options)
+    end
+    def put(uri, options={}) #:nodoc:
+      @@store.put(CloudKit::URI.new(uri), options)
+    end
+    def delete(uri, options={}) #:nodoc:
+      @@store.delete(CloudKit::URI.new(uri), options)
+    end
+    def resolve_uris(uris) #:nodoc:
+      @@store.resolve_uris(uris.map { |uri| CloudKit::URI.new(uri) })
+    end
+    # Return the version for this UserStore
+    def version; 1; end
+  end
+end

data/lib/cloudkit/util.rb ADDED

@@ -0,0 +1,25 @@
+module CloudKit
+  module Util
+    # Render ERB content
+    def erb(request, template, headers={'Content-Type' => 'text/html'}, status=200)
+      template_file = open(
+        File.join(File.dirname(__FILE__),
+        'templates',
+        "#{template.to_s}.erb"))
+      template = ERB.new(template_file.read)
+      result = template.result(binding)
+      Rack::Response.new(result, status, headers).finish
+    end
+    # Build a Rack::Router instance
+    def r(method, path, params=[])
+      Rack::Router.new(method, path, params)
+    end
+    # Remove the outer double quotes from a given string.
+    def unquote(text)
+      (text =~ /^\".*\"$/) ? text[1..-2] : text
+    end
+  end
+end

data/spec/ext_spec.rb ADDED

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/spec_helper'
+describe "A Hash" do
+  it "should re-key an entry if it exists" do
+    x = {:a => 1, :b => 2}
+    x.rekey!(:b, :c)
+    x.should == {:a => 1, :c => 2}
+    x.rekey!(:d, :b)
+    x.should == {:a => 1, :c => 2}
+  end
+  it "should re-key false and nil values" do
+    x = {:a => false, :b => nil}
+    x.rekey!(:b, :c)
+    x.should == {:a => false, :c => nil}
+    x.rekey!(:d, :b)
+    x.should == {:a => false, :c => nil}
+  end
+  it "should merge conditionally" do
+    x = {:a => 1}
+    y = {:b => 2}
+    x.filter_merge!(:c => y[:c])
+    x.should == {:a => 1}
+    x.filter_merge!(:c => y[:b])
+    x.should == {:a => 1, :c => 2}
+    x = {}.filter_merge!(:a => 1)
+    x.should == {:a => 1}
+  end
+  it "should merge false values correctly" do
+    x = {:a => 1}
+    y = {:b => 2}
+    x.filter_merge!(:c => false)
+    x.should == {:a => 1, :c => false}
+    x.filter_merge!(:c => y[:b])
+    x.should == {:a => 1, :c => 2}
+    x = {}.filter_merge!(:a => false)
+    x.should == {:a => false}
+  end
+  it "should exclude pairs using a single key" do
+    x = {:a => 1, :b => 2}
+    y = x.excluding(:b)
+    y.should == {:a => 1}
+  end
+  it "should exclude pairs using a list of keys" do
+    x = {:a => 1, :b => 2, :c => 3}
+    y = x.excluding(:b, :c)
+    y.should == {:a => 1}
+  end
+end
+describe "An Array" do
+  it "should exclude elements" do
+    x = [0, 1, 2, 3]
+    y = x.excluding(1, 3)
+    y.should == [0, 2]
+  end
+end
+describe "An Object" do
+  it "should try" do
+    x = {:a => 'a'}
+    result = x[:a].try(:upcase)
+    result.should == 'A'
+    lambda { x[:b].try(:upcase) }.should_not raise_error
+  end
+end

data/spec/flash_session_spec.rb ADDED

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/spec_helper'
+describe "A FlashSession" do
+  before do
+    @flash = CloudKit::FlashSession.new
+  end
+  it "should accept a value for a key" do
+    @flash['greeting'] = 'hello'
+    @flash['greeting'].should == 'hello'
+  end
+  it "should erase a key/value pair after access" do
+    @flash['greeting'] = 'hello'
+    x = @flash['greeting']
+    @flash['greeting'].should be_nil
+  end
+end

data/spec/memory_table_spec.rb ADDED

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/spec_helper'
+describe "A MemoryTable" do
+  before(:each) do
+    @table = CloudKit::MemoryTable.new
+  end
+  after(:each) do
+    @table.clear
+  end
+  it "should reject non-hash records" do
+    @table['a'] = 1
+    @table['a'].should be_nil
+  end
+  it "should reject non-string record keys" do
+    @table['a'] = {:foo => 'bar'}
+    @table['a'].should be_nil
+  end
+  it "should reject non-string record values" do
+    @table['a'] = {'foo' => 1}
+    @table['a'].should be_nil
+  end
+  it "should get and set values for table keys like a hash" do
+    @table['a'] = {'foo' => 'bar'}
+    @table['a'].should == {'foo' => 'bar'}
+  end
+  it "should clear its contents" do
+    @table['a'] = {'foo' => 'bar'}
+    @table['b'] = {'foo' => 'baz'}
+    @table.clear
+    @table['a'].should be_nil
+    @table['b'].should be_nil
+    @table.keys.should be_empty
+  end
+  it "should keep an ordered set of keys" do
+    @table['b'] = {'foo' => 'bar'}
+    @table['a'] = {'foo' => 'baz'}
+    @table.keys.should == ['b', 'a']
+  end
+  it "should generate incrementing ids" do
+    ids = []
+    4.times { ids << @table.generate_unique_id }
+    ids.should == [1, 2, 3, 4]
+  end
+  it "should query using a block supporting :eql comparisons" do
+    # For this release, only :eql comparisons are required
+    @table['a'] = {'foo' => 'bar', 'color' => 'blue'}
+    @table['b'] = {'foo' => 'baz', 'color' => 'blue'}
+    @table.query { |q|
+      q.add_condition('foo', :eql, 'bar')
+    }.should == [{'foo' => 'bar', 'color' => 'blue', :pk => 'a'}]
+    @table.query { |q|
+      q.add_condition('foo', :eql, 'baz')
+    }.should == [{'foo' => 'baz', 'color' => 'blue', :pk => 'b'}]
+    @table.query { |q|
+      q.add_condition('color', :eql, 'blue')
+    }.should == [
+      {'foo' => 'bar', 'color' => 'blue', :pk => 'a'},
+      {'foo' => 'baz', 'color' => 'blue', :pk => 'b'}]
+    @table.query { |q|
+      q.add_condition('foo', :eql, 'bar')
+      q.add_condition('color', :eql, 'blue')
+    }.should == [{'foo' => 'bar', 'color' => 'blue', :pk => 'a'}]
+    @table.query { |q|
+      q.add_condition('foo', :eql, 'bar')
+      q.add_condition('color', :eql, 'red')
+    }.should == []
+  end
+  it "should query without a block" do
+    @table['a'] = {'foo' => 'bar', 'color' => 'blue'}
+    @table['b'] = {'foo' => 'baz', 'color' => 'blue'}
+    @table.query.should == [
+      {'foo' => 'bar', 'color' => 'blue', :pk => 'a'},
+      {'foo' => 'baz', 'color' => 'blue', :pk => 'b'}]
+  end
+end