worochi 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ba8b523ca7164198a72a0cb2b02230f6a394012
-  data.tar.gz: 30d3cba96de58d8c04c6c2498f23e747ee320eef
+  metadata.gz: f09519cdd63d8cb13cbf636771bb69b8c0987d7e
+  data.tar.gz: 54df12c3131b7cf1c6d270d8503123042ce46e2e
 SHA512:
-  metadata.gz: 91d81134ec1ebd38502aadf22f4a90e19d648ae4cb8be0c15712961ad124ea8a57ef2ead0334af2d62a0dfb89270225f5a395880f10ab747238b2d8147806c25
-  data.tar.gz: 2f1665102e34f54b1f29f17c40da921854ebede6cadd1662fa5f8198f4d79c965f2bb1032b14700f98171f98a15d63c9b618e58c995f14c6bcd259793734f535
+  metadata.gz: 1afe2b334b5a04d8f8821b8900d7f7616744f9e677706d8ea6ef9a8ec971aadc085d7210b949fd0fee94292b38de01109b13e53b6ebdfeeea96bd97037145aa8
+  data.tar.gz: 628f241bbf0a90da4a4a623a34e61aeb13a57700163ad3c733139d1e489416eb58f5c6c452c6be1a55be0ff99b053199510e3b0fe9e13330cd30aab907c226d5

data/README.md

@@ -1,5 +1,169 @@
-Worochi
-===============================================================================
+# Worochi
+
+![Coverage Status](https://coveralls.io/repos/Pixelapse/worochi/badge.png?branch=master)
 
 Worochi provides a standard way to interface with Ruby API wrappers provided
-by various cloud storage services such as Dropbox and Google Drive.
+by various cloud storage services such as Dropbox and Google Drive.
+
+## Installation
+
+Worochi can be installed as a gem.
+
+    gem install worochi
+
+## Documentation
+
+[http://rdoc.info/gems/worochi][documentation]
+
+[documentation]: http://rdoc.info/gems/worochi
+
+## Basic Usage
+
+Pushing files is easy. Just create an agent using the OAuth authorization
+token for the user and then call {Worochi::Agent#push} or {Worochi.push}. File
+origins can be local, HTTP, or Amazon S3 paths.
+
+Pushing files to Dropbox:
+
+```ruby
+token = '982n3b989az'
+agent = Worochi.create(:dropbox, token)
+agent.push('test.txt')
+agent.files
+# => ['test.txt']
+```
+
+Pushing multiple files:
+
+```ruby
+agent.push(['a.txt', 'folder1/b.txt', 'http://example.com/c.txt'])
+agent.files
+# => ['a.txt', 'b.txt', 'c.txt']
+```
+
+Pushing files to more than one agent at the same time:
+
+```ruby
+a = Worochi.create(:dropbox, 'hxhrerx')
+b = Worochi.create(:dropbox, 'cdgrhdg')
+Worochi.push('test.txt')
+a.files
+# => ['test.txt']
+b.files
+# => ['test.txt']
+```
+
+Pushing to a specific folder:
+
+```ruby
+agent = Worochi.create(:dropbox, token, { dir: '/folder1' })
+agent.push('a.txt')
+
+agent.files
+# => ['a.txt']
+
+agent.set_dir('/')
+agent.push('b.txt')
+agent.files
+# => ['b.txt']
+
+agent.files_and_folders
+# => ['folder1', 'b.txt']
+agent.files('/folder1')
+# => ['a.txt']
+```
+
+## Amazon S3 Support
+
+Files can be retrieved directly from their Amazon S3 location either using the
+bucket name specified in the configuration or by specifiying a bucket name in
+the path.
+
+```ruby
+Worochi::Config.s3_bucket = 'rawr'
+
+agent.push('s3:path/to/file')
+# Retrieves from https://rawr.s3.amazonaws.com/path/to/file?AWSAccessKeyId=...
+
+agent.push('s3:pikachu:path/to/file')
+# Retrieves from https://pikachu.s3.amazonaws.com/path/to/file?AWSAccessKeyId=...
+```
+
+This uses Amazon's Ruby SDK to create a presigned URL for the specified file
+and then retrieves the file over HTTPS. `AWS_ACCESS_KEY_ID` and
+`AWS_SECRET_ACCESS_KEY` should be present in your environmental variables for
+this to work.
+
+## OAuth2 Flow
+
+Worochi provides helper methods to assist with the OAuth2 authorization flow.
+
+Example Rails controller:
+
+```ruby
+class ApiTokensController < ApplicationController
+
+  # GET /worochi/token/new/:service
+  def create
+    session[:oauth_flow_state] = state = SecureRandom.hex
+    redirect_to oauth.flow_start(state)
+  end
+
+  # GET /worochi/token/callback/:service
+  def callback
+    raise Error unless session[:oauth_flow_state] == params[:state]
+    token = oauth.flow_end(params[:code])
+    # token is a hash containing the retrieved access token
+  end
+
+private
+
+  def oauth
+    service = params[:service].to_sym
+    redirect_url = oauth_callback_url(service) # defined in routes.rb
+    Worochi::OAuth.new(service, redirect_url)
+  end
+end
+```
+
+Service-specific settings for OAuth2 are predefined in the gem, so the
+framework just needs to handle verification of session state (this is usually
+optional) and storing the retrieved access token value.
+
+## Development
+
+Each service is implemented as an {Worochi::Agent} object. Below is an
+overview of the files necessary for defining an agent to support a new
+service.
+
+The behaviors for each API are defined mainly in two files:
+
+    /worochi/lib/agent/foo_bar.rb
+    /worochi/lib/config/foo_bar.yml
+
+Optional helper file:
+
+    /worochi/lib/helper/foo_bar_helper.rb
+
+Test file:
+
+    /worochi/spec/worochi/agent/foo_bar_spec.rb
+
+Use underscore for filenames and corresponding mixed case for class name. The
+class name and service name symbol for the above example would be:
+
+    class Worochi::Agent::FooBar < Worochi::Agent
+    end
+
+    Worochi.create(:foo_bar, token)
+
+RSpec tests use the [VCR](https://github.com/vcr/vcr) gem to record and
+playback real HTTP interactions. Remember to filter out API tokens in the
+recordings.
+
+## Name
+
+Worochi is the archaic spelling of
+[Orochi](http://en.wikipedia.org/wiki/Yamata_no_Orochi), a mythical
+eight-headed serpent in Japanese mythology.
+

data/lib/worochi/item.rb

@@ -133,7 +133,7 @@ class Worochi
 
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = (uri.scheme == 'https')
-        request = Net::HTTP::Get.new uri
+        request = Net::HTTP::Get.new(uri.request_uri)
 
         http.request request do |response|
           response.read_body do |segment|

data/lib/worochi/oauth.rb

@@ -12,7 +12,7 @@ class Worochi
     attr_reader :client
 
     # @param service [Symbol] service name
-    # @param redirect_url [String] callback URL if required
+    # @param redirect_uri [String] callback URL if required
     def initialize(service, redirect_uri=nil)
       @options = Worochi::Config.service_opts(service).oauth
       options.service = service
@@ -38,12 +38,13 @@ class Worochi
     # Retrieves the token using the temporary authorization code.
     #
     # @param code [String] authorization code from the first part
-    # @return [OAuth2::AccessToken] OAuth2 token
+    # @return [Hashie::Mash] OAuth2 token
     def flow_end(code)
       client.site = options.token_site || options.site
       opts = {}
       opts[:redirect_uri] = options.redirect_uri if options.redirect_uri
-      client.auth_code.get_token(code, opts)
+      token = client.auth_code.get_token(code, opts)
+      Hashie::Mash.new(token.to_hash)
     end
 
     alias_method :get_token, :flow_end

data/lib/worochi/version.rb

@@ -1,4 +1,4 @@
 class Worochi
   # Current version of the gem
-  VERSION = '0.0.10'
+  VERSION = '0.0.12'
 end

data/lib/worochi.rb

@@ -1,5 +1,6 @@
 require 'hashie'
 require 'aws-sdk'
+require 'net/http'
 require 'worochi/config'
 require 'worochi/error'
 require 'worochi/log'

data/spec/support/test_files.rb

@@ -1,7 +1,7 @@
 module TestFiles
   # Remote file for testing.
   def remote
-    @remote ||= OpenStruct.new({
+    @remote ||= Hashie::Mash.new({
       source: 'http://soraven.com/blog/wp-content/uploads/2013/06/sr3.gif',
       checksum: '3c0d873709da4a08e9d9978f678dbc30a6cc5138182c2fee56db1c0b8b806d67',
       name: 'sr3.gif',
@@ -23,7 +23,7 @@ module TestFiles
 
   # Amazon S3 file for testing.
   def s3
-    @s3 ||= OpenStruct.new({
+    @s3 ||= Hashie::Mash.new({
       source: 's3:12061/271934/orig_232903',
       checksum: 'f0891f199f0966ec1b1d209b91ff3f51273577944dbbe338f1947ae9f33cb79a',
       name: '__init__.py',

data/worochi.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
 
   s.authors = ['Raven Jiang']
   s.email = ['raven@cs.stanford.edu']
-  s.homepage = 'http://rubygems.org/gems/worochi'
+  s.homepage = 'https://github.com/Pixelapse/worochi'
   s.license = 'MIT'
 
   s.files = %w(README.md LICENSE worochi.gemspec)
@@ -34,8 +34,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency('yard')
   s.add_development_dependency('simplecov')
   s.add_development_dependency('coveralls')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('redcarpet')
 
   s.post_install_message = <<-MESSAGE
-  Worochi says, "RAWRRRRR!!!"
+  Worochi says, \033[33;1m"RAWRRRRR!!!"\033[0m
   MESSAGE
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: worochi
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.12
 platform: ruby
 authors:
 - Raven Jiang
@@ -178,6 +178,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides a standard way to interface with Ruby API wrappers provided
   by various cloud storage services such as Dropbox and Google Drive.
 email:
@@ -266,12 +294,11 @@ files:
 - spec/cassettes/Worochi_Item/_open/opens_a_single_file/with_String_parameter.yml
 - spec/cassettes/Worochi_Item/_open/opens_a_single_file/with_Hash_parameter.yml
 - spec/cassettes/Worochi_OAuth/_flow_end/rejects_bad_code.yml
-homepage: http://rubygems.org/gems/worochi
+homepage: https://github.com/Pixelapse/worochi
 licenses:
 - MIT
 metadata: {}
-post_install_message: |2
-    Worochi says, "RAWRRRRR!!!"
+post_install_message: "  Worochi says, \e[33;1m\"RAWRRRRR!!!\"\e[0m\n"
 rdoc_options: []
 require_paths:
 - lib