tent-client 0.0.1 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 684ae790259d6f77983e1e7564178cdc84783bdf
+  data.tar.gz: f0c8d69166831d9fc4fe705ac7a1726273bb9206
+SHA512:
+  metadata.gz: fde0ae8fab7e514b187086ce8b2da941a56be9edae08014da3e4458752c2962bd3df11bf0bf834a639b454ef084fe3e4a57ddb99540a0f0f05222edf91d0b52f
+  data.tar.gz: b69ff67ec4a30e415d230bde232e91fbf05f11c36720998e65f002bb95b75b2367d0ba0f8b401b020232cb73d81dfe4c15f98aa2bf08e73c7958fcf7bd97dd52

data/.travis.yml

@@ -1,8 +1,6 @@
 language: ruby
 rvm:
+  - 2.0.0
   - 1.9.3
   - 1.9.2
-  - rbx-18mode
   - rbx-19mode
-  - 1.8.7
-  - ree

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in tent-client.gemspec
 gemspec
 
-gem 'faraday_middleware-multi_json', :git => 'git://github.com/jvatic/faraday_middleware-multi_json.git', :branch => :master
+gem 'hawk-auth', :git => 'git://github.com/tent/hawk-ruby.git', :branch => 'master'

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2013 Apollic Software, LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+   * Neither the name of Apollic Software, LLC nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,24 +1,13 @@
-# Tent Ruby Client ![Build Status](https://magnum.travis-ci.com/tent/tent-client-ruby.png?branch=master&token=YmxLSPgdpsxNUMWJpzRx)
+# Tent Ruby Client [![Build Status](https://travis-ci.org/tent/tent-client-ruby.png?branch=master)](https://travis-ci.org/tent/tent-client-ruby)
 
-TentClient implements a [Tent Protocol](http://tent.io) client library in Ruby.
-It is incomplete, currently only the endpoints required by
-[tentd](https://github.com/tent/tentd) and
-[tentd-admin](https://github.com/tent/tentd-admin) have been implemented.
+TentClient implements a [Tent Protocol](https://tent.io) client library in Ruby.
 
 ## Usage
 
-```ruby
-# Tent profile discovery
-TentClient.new.discover("http://tent-user.example.org")
+## Contributing
 
-# Server communication
-client = TentClient.new('http://tent-user.example.org',
-                        :mac_key_id => 'be94a6bf',
-                        :mac_key => '974af035',
-                        :mac_algorithm => 'hmac-sha-256')
-client.following.create('http://another-tent.example.com')
-```
-
-## Contributions
-
-If you find missing endpoints/actions, please submit a pull request.
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/tent-client.rb

@@ -1,81 +1,141 @@
 require 'tent-client/version'
-require 'oj'
 require 'faraday'
-require 'faraday_middleware'
-require 'faraday_middleware/multi_json'
+require 'tent-client/faraday/utils'
+require 'tent-client/multipart-post/parts'
+require 'tent-client/faraday/chunked_adapter'
+require 'tent-client/tent_type'
+require 'tent-client/middleware/content_type_header'
+require 'tent-client/middleware/encode_json'
+require 'tent-client/middleware/authentication'
+require 'tent-client/cycle_http'
+require 'tent-client/discovery'
+require 'tent-client/post'
+require 'tent-client/attachment'
+
+##
+# Ruby 1.8.7 compatibility
+require 'uri'
+unless URI.respond_to?(:encode_www_form_component)
+  require 'addressable/uri'
+
+  URI.class_eval do
+    def self.encode_www_form_component(str)
+      Addressable::URI.encode_component(
+        str.to_s.gsub(/(\r\n|\n|\r)/, "\r\n"),
+        Addressable::URI::CharacterClasses::UNRESERVED
+      ).gsub("%20", "+")
+    end
+  end
+end
 
 class TentClient
-  autoload :Discovery, 'tent-client/discovery'
-  autoload :LinkHeader, 'tent-client/link_header'
-  autoload :Follower, 'tent-client/follower'
-  autoload :Following, 'tent-client/following'
-  autoload :Group, 'tent-client/group'
-  autoload :Profile, 'tent-client/profile'
-  autoload :App, 'tent-client/app'
-  autoload :AppAuthorization, 'tent-client/app_authorization'
-  autoload :Post, 'tent-client/post'
-  autoload :PostAttachment, 'tent-client/post_attachment'
-  autoload :CycleHTTP, 'tent-client/cycle_http'
-
-  require 'tent-client/middleware/accept_header'
-  require 'tent-client/middleware/mac_auth'
-  require 'tent-client/middleware/encode_json'
-
-  MEDIA_TYPE = 'application/vnd.tent.v0+json'.freeze
-  PROFILE_REL = 'https://tent.io/rels/profile'.freeze
-
-  attr_reader :faraday_adapter, :server_urls
-
-  def initialize(server_urls = [], options={})
-    @server_urls = Array(server_urls)
+  POST_MEDIA_TYPE = %(application/vnd.tent.post.v0+json).freeze
+  POST_CONTENT_TYPE = %(#{POST_MEDIA_TYPE}; type="%s").freeze
+  POST_MENTIONS_CONTENT_TYPE = %(application/vnd.tent.post-mentions.v0+json).freeze
+  POST_VERSIONS_CONTENT_TYPE = %(application/vnd.tent.post-versions.v0+json).freeze
+  POST_CHILDREN_CONTENT_TYPE = %(application/vnd.tent.post-children.v0+json).freeze
+  OAUTH_TOKEN_CONTENT_TYPE = %(application/vnd.tent.oauth.token.v0+json).freeze
+  MULTIPART_CONTENT_TYPE = 'multipart/form-data'.freeze
+  MULTIPART_BOUNDARY = "-----------TentPart".freeze
+
+  MalformedServerMeta = Class.new(StandardError)
+  ServerNotFound = Class.new(StandardError)
+
+  attr_reader :entity_uri, :options
+  attr_writer :faraday_adapter, :faraday_setup, :server_meta_post
+  attr_accessor :ts_skew
+  def initialize(entity_uri, options = {})
+    @server_meta_post = options.delete(:server_meta)
     @faraday_adapter = options.delete(:faraday_adapter)
-    @options = options
+    @faraday_setup = options.delete(:faraday_setup)
+    @ts_skew = options.delete(:ts_skew)
+    @entity_uri, @options = entity_uri, options
   end
 
-  def http
-    @http ||= CycleHTTP.new(self) do |f|
+  def dup
+    self.class.new(@entity_uri, @options.merge(
+      :server_meta => @server_meta_post,
+      :faraday_adapter => @faraday_adapter,
+      :faraday_setup => @faraday_setup
+    ))
+  end
+
+  def server_meta
+    server_meta_post['content'] if server_meta_post
+  end
+
+  def server_meta_post
+    @server_meta_post ||= entity_uri ? Discovery.discover(self, entity_uri) : nil
+  end
+
+  def primary_server
+    server_meta['servers'].sort_by { |s| s['preference'] }.first
+  end
+
+  def new_http
+    authentication_options = {}
+    authentication_options[:ts_skew] = @ts_skew if @ts_skew
+    authentication_options[:ts_skew_retry_enabled] = @options.has_key?(:ts_skew_retry_enabled) ? @options[:ts_skew_retry_enabled] : true
+    authentication_options[:update_ts_skew] = proc do |skew|
+      @ts_skew = skew
+    end
+
+    @http = CycleHTTP.new(self) do |f|
+      f.use Middleware::ContentTypeHeader
       f.use Middleware::EncodeJson unless @options[:skip_serialization]
-      f.response :multi_json, :content_type => /\bjson\Z/ unless @options[:skip_serialization]
-      f.use Middleware::AcceptHeader
-      f.use Middleware::MacAuth, @options
+      f.use Middleware::Authentication, @options[:credentials], authentication_options if @options[:credentials]
+      f.response :multi_json, :content_type => /\bjson\Z/ unless @options[:skip_serialization] || @options[:skip_response_serialization]
+      @faraday_setup.call(f) if @faraday_setup
       f.adapter *Array(faraday_adapter)
     end
   end
 
+  def http
+    @http || new_http
+  end
+
   def faraday_adapter
     @faraday_adapter || Faraday.default_adapter
   end
 
-  def server_url=(v)
-    @server_urls = Array(v)
-    @http = nil # reset Faraday connection
+  def faraday_adapter=(adapter)
+    @faraday_adapter = adapter
   end
 
-  def discover(url)
-    Discovery.new(self, url).tap { |d| d.perform }
+  def hex_digest(data)
+    if data.kind_of?(IO)
+      _data = data.read
+      data.rewind
+      data = _data
+    end
+    Digest::SHA512.new.update(data).to_s[0...64]
   end
 
-  def follower
-    Follower.new(self)
+  def post
+    Post.new(self)
   end
 
-  def following
-    Following.new(self)
+  def attachment
+    Attachment.new(self)
   end
 
-  def group
-    Group.new(self)
-  end
+  def oauth_redirect_uri(params = {})
+    uri = URI(primary_server['urls']['oauth_auth'])
 
-  def app
-    App.new(self)
-  end
+    query = params.inject([]) { |m, (k,v)| m << "#{k}=#{URI.encode_www_form_component(v)}"; m }.join('&')
+    uri.query ? uri.query += "&#{query}" : uri.query = query
 
-  def post
-    Post.new(self)
+    uri
   end
 
-  def profile
-    Profile.new(self)
+  def oauth_token_exchange(data, &block)
+    new_block = proc do |request|
+      request.headers['Content-Type'] = OAUTH_TOKEN_CONTENT_TYPE
+      yield(request) if block_given?
+    end
+    http.post(:oauth_token, params = {}, {
+      :token_type => 'https://tent.io/oauth/hawk-token'
+    }.merge(data), &new_block)
   end
+
 end

data/lib/tent-client/attachment.rb

@@ -0,0 +1,13 @@
+class TentClient
+  class Attachment
+    attr_reader :client
+    def initialize(client)
+      @client = client.dup
+      @client.faraday_adapter = :net_http_stream
+    end
+
+    def get(entity, digest, params = {}, &block)
+      client.http.get(:attachment, { :entity => entity, :digest => digest }.merge(params), &block)
+    end
+  end
+end

data/lib/tent-client/cycle_http.rb

@@ -1,39 +1,112 @@
+require 'yajl'
+
 class TentClient
 
   # Proxies to Faraday and cycles through server urls
   #   until either non left or response status in the 200s or 400s
   class CycleHTTP
-    attr_reader :client, :server_urls
+    attr_reader :client, :servers
     def initialize(client, &faraday_block)
       @faraday_block = faraday_block
       @client = client
-      @server_urls = client.server_urls.dup
+
+      if client.entity_uri
+        unless (Hash === client.server_meta) && (Array === client.server_meta['servers'])
+          raise MalformedServerMeta.new("Server meta post for Entity(#{client.entity_uri.inspect}) is malformed: #{client.server_meta.inspect}")
+        end
+
+        @servers = client.server_meta['servers'].sort_by { |s| s['preference'] }
+      else
+        @servers = []
+      end
+    end
+
+    def current_server
+      @current_server || servers.first
     end
 
     def new_http
-      @http = Faraday.new(:url => server_urls.shift) do |f|
+      @current_server = servers.shift
+      @http = Faraday.new do |f|
         @faraday_block.call(f)
       end
     end
 
     def http
-      @http || new_http
+      @http ||= new_http
     end
 
-    %w{ head get put post patch delete options }.each do |verb|
-      define_method verb do |*args, &block|
-        res = http.send(verb, *args, &block)
-        return res unless server_urls.any?
-        case res.status
-        when 200...300, 400...500
-          res
-        else
-          new_http
-          send(verb, *args, &block)
+    def named_url(name, params = {})
+      unless (Hash === current_server) && (Hash === current_server['urls']) && (template = current_server['urls'][name.to_s])
+        raise ServerNotFound.new("Failed to match #{name.to_s.inspect} to a url for server: #{Yajl::Encoder.encode(current_server)}")
+      end
+
+      template.to_s.gsub(/\{([^\}]+)\}/) {
+        param = (params.delete($1) || params.delete($1.to_sym)).to_s
+        URI.encode_www_form_component(param)
+      }
+    end
+
+    %w( options get head delete ).map(&:to_sym).each do |verb|
+      class_eval(<<-RUBY
+        def #{verb}(url, params = {}, headers = {}, &block)
+          run_request(#{verb.inspect}, url, params, nil, headers, &block)
+        end
+RUBY
+      )
+    end
+
+    %w( post put patch ).map(&:to_sym).each do |verb|
+      class_eval(<<-RUBY
+        def #{verb}(url, params = {}, body = nil, headers = {}, &block)
+          run_request(#{verb.inspect}, url, params, body, headers, &block)
         end
+RUBY
+      )
+    end
+
+    def multipart_request(verb, url, params, parts, headers = {}, &block)
+      body = multipart_body(parts)
+      run_request(verb.to_sym, url, params, body, headers) do |request|
+        request.headers['Content-Type'] = "#{MULTIPART_CONTENT_TYPE}; boundary=#{MULTIPART_BOUNDARY}"
+        request.headers['Content-Length'] = body.length.to_s
+        yield(request) if block_given?
       end
     end
 
+    def run_request(verb, url, params, body, headers, &block)
+      args = [verb, url, params, body, headers]
+      if Symbol === url
+        name = url
+        url = named_url(url, params || {})
+      else
+        name = nil
+      end
+
+      res = http.run_request(verb, url, body, headers) do |request|
+        request.params.update(params) if params
+        yield request if block_given?
+      end
+
+      if name
+        res.env[:tent_server] = current_server
+      end
+
+      return res if servers.empty? || !name
+
+      case res.status
+      when 200...300, 400...500
+        res
+      else
+        new_http
+        run_request(*args, &block)
+      end
+    rescue Faraday::Error::TimeoutError, Faraday::Error::ConnectionFailed
+      raise if servers.empty?
+      new_http
+      run_request(*args, &block)
+    end
+
     def respond_to_missing?(method_name, include_private = false)
       http.respond_to?(method_name, include_private)
     end
@@ -45,5 +118,42 @@ class TentClient
         super
       end
     end
+
+    private
+
+    def multipart_body(parts)
+      # group by category
+      parts = parts.inject(Hash.new) do |memo, part|
+        category = part[:category] || part['category']
+        memo[category] ||= []
+        memo[category] << part
+        memo
+      end
+
+      # expend into request parts
+      parts = parts.inject(Array.new) do |memo, (category, category_parts)|
+        if category_parts.size > 1
+          memo.concat category_parts.each_with_index.map { |part, index|
+            headers = part[:headers] || part['headers']
+            Faraday::Parts::FilePart.new(MULTIPART_BOUNDARY, "#{category}[#{index}]", upload_io(part), headers)
+          }
+        else
+          part = category_parts.first
+          headers = part[:headers] || part['headers']
+          memo << Faraday::Parts::FilePart.new(MULTIPART_BOUNDARY, category, upload_io(part), :headers => headers)
+        end
+      end
+
+      parts << Faraday::Parts::EpiloguePart.new(MULTIPART_BOUNDARY)
+      Faraday::CompositeReadIO.new(parts)
+    end
+
+    def upload_io(part)
+      Faraday::UploadIO.new(
+        (part[:file] || part['file']) || StringIO.new(part[:data] || part['data']),
+        part[:content_type] || part['content-type'],
+        part[:filename] || part['filename']
+      )
+    end
   end
 end