hubic 0.0.1 → 0.0.2

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 sdalu
+Copyright (c) 2014 Stephane D'Alu
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,11 +4,25 @@ Hubic
 Requirement
 -----------
 You need to retrieve the client id, secret key, and redirection url. 
-For that if not alredy done you need to register an application into your account. 
-To start the registration process you will need to go to ``My Account``, select ``Your application``, and click on ``Add an application``.
+For that if not already done you need to register an application into
+your account. 
+To start the registration process you will need to go to ``My Account``,
+select ``Your application``, and click on ``Add an application``.
 
 Quick example
 -------------
+From the commande line:
+
+```sh
+HUBIC_USER=foo@bar.com                  # Set the user on which we will act
+hubic client   config                   # Configure the client API key
+hubic auth                              # Authenticate the user
+hubic upload   file.txt cloud/file.txt  # Upload file
+hubic download cloud/file.txt           # Download file
+hubic delete   cloud/file.txt           # Remove file
+```
+
+From a ruby script:
 ```ruby
 require 'hubic'
 

data/Rakefile

@@ -3,9 +3,14 @@
 require "rbconfig"
 require "rubygems"
 require "bundler/setup"
+require "yard"
 
 include Rake::DSL
 
 
 Bundler::GemHelper.install_tasks
 
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']   # optional
+#  t.options = ['--any', '--extra', '--opts'] # optional
+end

data/bin/hubic

@@ -0,0 +1,131 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'hubic'
+require 'highline'
+
+
+HUBIC_CLIENT_CFG = "#{ENV['HOME']}/.hubic-client"
+
+exclusive_options = []
+container = nil
+user      = ENV['HUBIC_USER']
+
+error_proc = lambda do |msg|
+  $stderr.puts(msg)
+  exit 1
+end
+
+
+options = OptionParser.new do |opts|
+    opts.banner = "Hubic: access your data"
+    opts.define_head "Usage: hubic [options] <uri|path> [file]"
+    opts.separator ""
+    opts.separator "Examples:"
+    opts.separator "  HUBIC_USER=foo@bar.com"
+    opts.separator "  hubic client   config"
+    opts.separator "  hubic auth"
+    opts.separator "  hubic upload   local-file.txt documents/cloud-file.txt"
+    opts.separator "  hubic download documents/cloud-file.txt"
+    opts.separator "  hubic delete   documents/cloud-file.txt"
+    opts.separator ""
+    opts.separator "Options:"
+    
+    opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+    end
+    
+    opts.on("-c", "--container STRING", "Use the give container as default") do  |v|
+        container = v
+        exclusive_options << :container
+    end
+    
+
+    opts.on("-u", "--user STRING", "User account to use") do  |v|
+        user = v
+    end
+
+    opts.on("-V", "--verbose", "Be verbose about action performed") do
+        require 'logger'
+        loggers << Logger.new($stdout)
+    end
+  
+    opts.on_tail("-v", "--version", "Show version") do
+        puts "Hubic #{Hubic::VERSION}"
+        exit
+    end
+end
+opts = options
+opts.parse!
+
+$term = HighLine.new
+
+action = ARGV.shift
+
+# Manage client configuration
+if action == 'client'
+    case ARGV[0]
+    when 'config'
+        ARGV.shift
+        cfg = case ARGV.length
+              when 0
+                  [ $term.ask("Client ID    : ").to_s,
+                    $term.ask("Client Secret: ").to_s,
+                    $term.ask("Redirect URI : ").to_s ]
+              when 3
+                  ARGV
+              else
+                  error_proc["hubic client config [client_id client_secret_ redirect_uri"]
+              end
+        File.open(HUBIC_CLIENT_CFG, 'w', 0600) {|io|
+            io.write({ 'client_id'     => cfg[0],
+                       'client_secret' => cfg[1],
+                       'redirect_uri'  => cfg[2], }.to_yaml)
+        }
+        exit
+    when 'reset'
+        File.unlink(HUBIC_CLIENT_CFG)
+        exit
+    end
+end
+
+
+# Configure Hubic client
+if ENV.include?('HUBIC_REDIRECT_URI' ) &&
+   ENV.include?('HUBIC_CLIENT_ID'    ) &&
+   ENV.include?('HUBIC_CLIENT_SECRET')
+    Hubic.default_redirect_uri  = ENV['HUBIC_REDIRECT_URI' ]
+    Hubic.default_client_id     = ENV['HUBIC_CLIENT_ID'    ]
+    Hubic.default_client_secret = ENV['HUBIC_CLIENT_SECRET']
+else
+    begin
+        cfg = YAML.load_file(HUBIC_CLIENT_CFG)
+        Hubic.default_redirect_uri  = cfg['redirect_uri' ] 
+        Hubic.default_client_id     = cfg['client_id'    ] 
+        Hubic.default_client_secret = cfg['client_secret'] 
+    rescue Errno::ENOENT
+        error_proc["Plase run: hubic client config"]
+    end
+end
+
+if user.nil?
+    
+end
+
+
+case action
+when 'auth'
+    Hubic.for_user(user, ARGV[0], force: true) {|user|
+        ($term.ask("Password for #{user}: ", String) {|q| q.echo = 'x' }).to_s
+    }
+when 'download' # hubic / local
+    obj = ARGV[0]
+    dst = ARGV[1] || File.basename(obj)
+    Hubic.for_user(user).download(obj, dst)
+when 'upload'   # local / hubic
+    src = ARGV[0]
+    obj = ARGV[1]
+    Hubic.for_user(user).upload(src, obj)
+end

data/hubic.gemspec

@@ -13,8 +13,11 @@ Gem::Specification.new do |s|
   s.description = "Manage your Hubic account from Ruby"
 
   s.add_dependency "faraday", "~>0.9"
+  s.add_dependency "mime-types"
+  s.add_dependency "highline"
   s.add_dependency "nokogiri"
   s.add_development_dependency "rake"
+  s.add_development_dependency "yard"
 
   s.files = `git ls-files`.split("\n")
   s.executables = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

data/lib/hubic.rb

@@ -32,32 +32,46 @@ class Hubic
         end
     end
 
-
+    # Set the default client Id to use
     def self.default_client_id=(client_id)
         @@client_id = client_id
     end
 
+    # Set the default client Secret to use
     def self.default_client_secret=(client_secret)
         @@client_secret = client_secret
     end
 
+    # Set the default redirect URI to use
     def self.default_redirect_uri=(redirect_uri)
         @@redirect_uri = redirect_uri
     end
 
-
-    def self.for_user(user, password=nil, store: Store[user],
-                      &password_requester)
+    # Create a Hubic handler
+    # @param user [String]
+    # @param password [String]
+    # @param store 
+    # @param force [true, false]
+    # @param password_requester
+    # @return [Hubic] an Hubic handler
+    def self.for_user(user, password=nil, 
+                      store: Store[user], force: false, &password_requester)
         h = Hubic.new(@@client_id, @@client_secret, @@redirect_uri)
-        h.for_user(user, password, store: store, &password_requester)
+        h.for_user(user, password, 
+                   store: store, force: force, &password_requester)
         h
     end
 
 
+    # Create a Hubic handler
+    # @param client_id
+    # @param client_secret
+    # @param redirect_uri
     def initialize(client_id     = @@client_id,
                    client_secret = @@client_secret,
                    redirect_uri  = @@redirect_uri)
         @store         = nil
+        @refresh_token = nil
         @client_id     = client_id
         @client_secret = client_secret
         @redirect_uri  = redirect_uri
@@ -69,9 +83,16 @@ class Hubic
         @default_container = "default"
     end
 
-    def for_user(user, password=nil, store: Store[user], &password_requester)
+    # Initialize the Hubic handler to perform operations on behalf of the user
+    # @param user [String]
+    # @param password [String]
+    # @param store 
+    # @param force [true, false]
+    # @param password_requester
+    def for_user(user, password=nil,
+                 store: Store[user], force: false, &password_requester)
         @store         = store
-        @refresh_token = @store['refresh_token'] if @store
+        @refresh_token = @store['refresh_token'] if @store && !force
 
         if @refresh_token
             data = refresh_access_token
@@ -95,6 +116,10 @@ class Hubic
     end
 
 
+
+
+
+
     def account
         api_hubic(:get, '/1.0/account')
     end
@@ -103,14 +128,17 @@ class Hubic
         api_hubic(:get, '/1.0/account/credentials')
     end
 
-
-
-    def [](path=nil, container=@default_container)
-#        objects(path, container: container)
+    def usage
+        api_hubic(:get, '/1.0/account/usage')
     end
 
-    
 
+    
+    # Make a call to the Hubic API
+    # @param method [:get, :post, :delete]
+    # @param path
+    # @param params [Hash]
+    # @return [Hash]
     def api_hubic(method, path, params=nil)
         r = @conn.method(method).call(path) do |req|
             req.headers['Authorization'] = "Bearer #{@access_token}"
@@ -121,7 +149,12 @@ class Hubic
 
     private
 
-
+    # Obtain a request code from the Hubic server.
+    # We will ask for the code, and validate the form on the user behalf.
+    #
+    # @param user [String]
+    # @param password [String]
+    # @return [String] the request code
     def get_request_code(user, password)
         # Request code (retrieve user confirmation form)
         r = @conn.get '/oauth/auth', {
@@ -168,6 +201,9 @@ class Hubic
         end
     end
 
+    # Request an access token, this will also acquiere a refresh token.
+    # @param code [String] the request code
+    # @return Hash
     def get_access_token(code)
         r = @conn.post '/oauth/token', {
             :code          => code,
@@ -190,6 +226,8 @@ class Hubic
         end
     end
 
+    # Refresh the access token
+    # @return Hash
     def refresh_access_token
         if @refresh_token.nil?
             raise Error, "refresh_token was not previously acquiered" 

data/lib/hubic/file_ops.rb

@@ -1,9 +1,9 @@
-class Hubic
+require 'mime/types'
 
-    # File operations
-    #######################################################################
+class Hubic
 
     def download(obj, dst=nil, size: nil, offset: 0, &block)
+        # Handle file name or nil as a posible destination
         io   = nil
         dst  = Pathname(dst) if String === dst
         _dst = case dst
@@ -12,12 +12,16 @@ class Hubic
                else dst
                end
 
+        # Get object
         meta = get_object(obj, _dst, size: size, offset: offset, &block)
 
+        # If file name update the timestamp
         if (Pathname === dst) && meta[:lastmod]
             dst.utime(meta[:lastmod], meta[:lastmod])
         end
-
+        
+        # If destination is nil, returns the downloaded file
+        # insteaded of the meta data
         if dst.nil?
         then io.flush.string
         else meta
@@ -26,8 +30,13 @@ class Hubic
         io.close unless io.nil?
     end
 
-    def upload(src, obj, &block)
-        put_object(src, obj, &block)
+    def upload(src, obj, type='application/octet-stream', &block)
+        case src
+        when String, Pathname
+            type = (MIME::Types.of(src).first ||
+                    MIME::Types['application/octet-stream'].first).content_type
+        end
+        put_object(obj, src, type, &block)
     end
 
     def copy(src, dst)

data/lib/hubic/openstack.rb

@@ -118,16 +118,49 @@ class Hubic
         http.finish unless http.nil?
     end
 
-    def put_object(src, obj, &block)
+    def put_object(obj, src, type='application/octet-stream', &block)
         container, path, uri = normalize_object(obj)
+        io = File.open(src)
 
-        r = @conn.put(uri) do |req|
-            req.headers['X-Auth-Token'] = @os[:token]
-            req.params[:file] = Faraday::UploadIO.new(src, 'text/plain')
+        hdrs = {}
+        hdrs['X-Auth-Token'     ] = @os[:token]
+        hdrs['Transfer-Encoding'] = 'chunked'
+        hdrs['Content-Type'     ] = type
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        if uri.scheme == 'https'
+            http.use_ssl = true
+            # http.verify_mode = OpenSSL::SSL::VERIFY_NONE
         end
-        puts r.inspect
+        http.start
+
+        request = Net::HTTP::Put.new(uri.request_uri, hdrs)
+        request.body_stream = io
+        http.request(request) {|response|
+            case response
+            when Net::HTTPSuccess
+            when Net::HTTPRedirection
+                fail "http redirect is not currently handled"
+            when Net::HTTPUnauthorized
+                # TODO: Need to refresh token
+            else
+                fail "resource unavailable: #{uri} (#{response.class})"
+            end
+
+            puts response.inspect
+        }
+        if block
+            block.call(:done)
+        end
+    ensure
+        io.close unless io.nil?
+        http.finish unless http.nil?
     end
 
+    # List objects store in a container.
+    #
+    # @param container [String] the name of the container.
+    # @return [Array] the list of objects (as a Hash)
     def objects(container = @default_container, 
                 path: nil, limit: nil, gt: nil, lt: nil)
         path = path[1..-1] if path && path[0] == ?/
@@ -163,7 +196,7 @@ class Hubic
         params[:format] ||= :json
 
         p = "#{@os[:endpoint]}#{'/' if path[0] != ?/}#{path}"
-        r = @conn.method(method).call(p) do |req|
+        r = @os[:conn].method(method).call(p) do |req|
             req.headers['X-Auth-Token'] = @os[:token]
             req.params = params
         end
@@ -188,6 +221,7 @@ class Hubic
 
     def openstack_setup(endpoint, token, expires)
         conn = Faraday.new  do |faraday|
+            faraday.request  :multipart
             faraday.request  :url_encoded
             faraday.adapter  :net_http
             faraday.options.params_encoder =  Faraday::FlatParamsEncoder
@@ -201,6 +235,8 @@ class Hubic
     end
 
     def normalize_object(obj)
+        openstack_setup_refresh
+
         c, p = case obj
                when String 
                    [ @default_container, obj ]
@@ -213,6 +249,8 @@ class Hubic
                    when 2 then Symbol === obj[1] ? [ obj[1], obj[0] ] : obj
                    else raise ArguementError
                    end
+               else
+                   raise ArgumentError
                end
         c = c.to_s
         p = p[1..-1] if p[0] == ?/

data/lib/hubic/version.rb

@@ -1,3 +1,3 @@
 class Hubic
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubic
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -27,6 +27,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -59,10 +91,27 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Manage your Hubic account from Ruby
 email:
 - sdalu@sdalu.com
-executables: []
+executables:
+- hubic
 extensions: []
 extra_rdoc_files: []
 files:
@@ -71,6 +120,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/hubic
 - hubic.gemspec
 - lib/hubic.rb
 - lib/hubic/file_ops.rb
@@ -91,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4363560357882864147
+      hash: 254901150746708933
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -100,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4363560357882864147
+      hash: 254901150746708933
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.29
@@ -108,3 +158,4 @@ signing_key:
 specification_version: 3
 summary: Manage your Hubic account from Ruby
 test_files: []
+has_rdoc: