worochi 0.0.7 → 0.0.10

data/lib/worochi/helper.rb

@@ -1,18 +1,34 @@
-require 'aws-sdk' unless Worochi::Config.s3_bucket.nil?
-
 class Worochi
   # Contains any global helper methods not specific to any individual service.
   module Helper
     class << self
       # Given an S3 path, return the full URL for the corresponding object
-      # determined using the AWS SDK.
+      # determined using the AWS SDK. AWS_SECRET_ACCESS_KEY and
+      # AWS_ACCESS_KEY_ID should be present in ENV. The string should be
+      # formatted as: `s3:(bucket_name:)path/to/file`.
       #
-      # @param path [String]
-      # @return [URI::HTTP]
+      # @param path [String] S3 path
+      # @return [URI::HTTPS] URI of the file on S3
+      # @example Pre-configured bucket name
+      #   Worochi::Config.s3_bucket = 'worochi'
+      #   Worochi::Helper.s3_url('s3:test/path')
+      #   # => #<URI::HTTPS URL:https://worochi.s3.amazonaws.com/test/path?AWSAccessKeyId=...>
+      # @example Custom bucket name
+      #   Worochi::Helper.s3_url('s3:bucket-name:a/b')
+      #   # => #<URI::HTTPS URL:https://bucket-name.s3.amazonaws.com/a/b?AWSAccessKeyId=...>
+      # @example Invalid syntax
+      #   Worochi::Helper.s3_url('www.a.com/b.txt')
+      #   # => Worochi::Error
       def s3_url(path)
-        raise Error, 'S3 bucket name is not defined' if Config.s3_bucket.nil?
+        raise Error, 'Invalid S3 path' unless is_s3_path?(path)
         path = path.sub(s3_prefix_re, '')
-        AWS::S3.new.buckets[Config.s3_bucket].objects[path].url_for(:read)
+        if match = /^(.*)\:/.match(path)
+          bucket = match[1]
+          path = path.sub(/^(.*)\:/, '')
+        end
+        bucket ||= Config.s3_bucket
+        raise Error, 'S3 bucket name is not defined' if bucket.nil?
+        AWS::S3.new.buckets[bucket].objects[path].url_for(:read)
       end
 
       # Check if a given path is an S3 path.
@@ -33,4 +49,9 @@ class Worochi
       end
     end
   end
+end
+
+# Load all helpers
+Dir[File.join(File.dirname(__FILE__), 'helper/[^#]*.rb')].each do |file|
+  require 'worochi/helper/' + File.basename(file, '.rb')
 end

data/lib/worochi/item.rb

@@ -102,8 +102,10 @@ class Worochi
         if File.file?(source)
           retrieve_local(source)
         else
-          url = Helper.is_s3_path?(source) ? Helper.s3_url(source) : source
-          retrieve_remote(url)
+          if Config.s3_enabled? && Helper.is_s3_path?(source)
+            source = Helper.s3_url(source)
+          end
+          retrieve_remote(source)
         end        
       end
 
@@ -118,7 +120,7 @@ class Worochi
         file
       end
 
-      # Downloads a remote file using {HTTP::Get}.
+      # Downloads a remote file using `HTTP::Get`.
       #
       # @param file_url [String, URI] the URL of the file
       # @return [Tempfile] the downloaded file

data/lib/worochi/log.rb

@@ -13,8 +13,10 @@ class Worochi
     }
     class << self
       # Initializes the logging system.
-      def init_log
-        @logger = Logger.new(STDOUT)
+      #
+      # @param logdev [IO] target device to log to
+      def init(logdev=nil)
+        @logger = Logger.new(logdev || Config.logdev)
         @logger.formatter = proc do |severity, datetime, progname, msg|
           "[\033[#{SEVERITY_COLOR[severity]}m#{severity}\033[0m]: #{msg}\n"
         end
@@ -22,30 +24,22 @@ class Worochi
 
       # Prints DEBUG messages
       def debug(message)
-        return if Worochi::Config.silent?
-        init_log if @logger.nil?
-        @logger.debug message
+        @logger.debug message unless Worochi::Config.silent?
       end
 
       # Prints WARN messages
       def warn(message)
-        return if Worochi::Config.silent?
-        init_log if @logger.nil?
-        @logger.warn message
+        @logger.warn message unless Worochi::Config.silent?
       end
 
       # Prints INFO messages
       def info(message)
-        return if Worochi::Config.silent?
-        init_log if @logger.nil?
-        @logger.info message
+        @logger.info message unless Worochi::Config.silent?
       end
 
       # Prints ERROR messages
       def error(message)
-        return if Worochi::Config.silent?
-        init_log if @logger.nil?
-        @logger.error message
+        @logger.error message unless Worochi::Config.silent?
       end
     end
   end

data/lib/worochi/oauth.rb

@@ -0,0 +1,69 @@
+require 'oauth2'
+
+class Worochi
+  # Implements OAuth2 authorization code flow for obtaining user tokens.
+  class OAuth
+    # OAuth2 options.
+    # @return [Hashie::Mash]
+    attr_accessor :options
+
+    # The OAuth2 client
+    # @return [OAuth2::Client]
+    attr_reader :client
+
+    # @param service [Symbol] service name
+    # @param redirect_url [String] callback URL if required
+    def initialize(service, redirect_uri=nil)
+      @options = Worochi::Config.service_opts(service).oauth
+      options.service = service
+      options.redirect_uri = redirect_uri
+      opts = { site: options.site }
+      opts[:authorize_url] = options.authorize_url if options.authorize_url
+      opts[:token_url] = options.token_url if options.token_url
+      @client = OAuth2::Client.new(id, secret, opts)
+    end
+
+    # Returns the URL to start the authorization flow.
+    #
+    # @param state [String] optional security verification state
+    # @return [String] URL to begin flow
+    def flow_start(state=nil)
+      client.site = options.site
+      opts = { scope: scope }
+      opts[:state] = state if state
+      opts[:redirect_uri] = options.redirect_uri if options.redirect_uri
+      client.auth_code.authorize_url(opts)
+    end
+
+    # Retrieves the token using the temporary authorization code.
+    #
+    # @param code [String] authorization code from the first part
+    # @return [OAuth2::AccessToken] 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)
+    end
+
+    alias_method :get_token, :flow_end
+
+  private
+    # @return [String] scope
+    def scope
+      options.scope || ''
+    end
+
+    # @return [String] environmental variable for client ID
+    def id
+      var = options.id_env || options.service.to_s.upcase + '_ID'
+      ENV[var]
+    end
+
+    # @return [String] environmental variable for client secret
+    def secret
+      var = options.secret_env || options.service.to_s.upcase + '_SECRET'
+      ENV[var]
+    end
+  end
+end

data/lib/worochi/version.rb

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

data/lib/worochi.rb

@@ -1,9 +1,12 @@
+require 'hashie'
+require 'aws-sdk'
 require 'worochi/config'
 require 'worochi/error'
 require 'worochi/log'
-require 'worochi/helper'
 require 'worochi/item'
 require 'worochi/agent'
+require 'worochi/oauth'
+require 'worochi/helper'
 
 # The main class for the gem. This and the {Agent} class are the main
 # endpoints for interacting with the remote services.
@@ -16,6 +19,15 @@ class Worochi
     # @return [Array]
     attr_reader :agents
 
+    # Initialize configurations and logging.
+    #
+    # @return [nil]
+    def init
+      Config.load_yaml
+      Log.init
+      reset
+    end
+
     # Creates a new {Worochi::Agent} and adds it to the list of agents
     # listening to {Worochi.push} requests.
     #
@@ -113,9 +125,14 @@ class Worochi
     # @see Item.open
     # @see Agent#push
     def push(origin, opts={})
-      Log.warn 'No push targets specified' and return false if @agents.empty?
+      if @agents.empty?
+        Log.warn 'No push targets specified'
+        return false
+      end
       @agents.each { |agent| agent.push(origin, opts) }
       true
     end
   end
-end
+end
+
+Worochi.init