rbox 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'faraday', '>= 0.7.0', :require => 'faraday'
+gem 'faraday_middleware', '>= 0.7.0', :require => 'faraday_middleware'
+gem 'multi_xml', '~> 0.4.1'
+
+group :test do
+  gem 'minitest'
+  gem 'vcr'
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    faraday (0.8.0)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.8.7)
+      faraday (>= 0.7.4, < 0.9)
+    minitest (2.11.1)
+    multi_xml (0.4.1)
+    multipart-post (1.1.5)
+    rake (0.9.2.2)
+    vcr (2.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday (>= 0.7.0)
+  faraday_middleware (>= 0.7.0)
+  minitest
+  multi_xml (~> 0.4.1)
+  rake
+  vcr

data/lib/rbox.rb

@@ -0,0 +1,33 @@
+# Client modules
+require 'rbox/connection'
+require 'rbox/authentication'
+require 'rbox/download'
+require 'rbox/item'
+# Client class
+require 'rbox/client'
+
+# Utility methods modules
+require 'rbox/utils/collect_nested_key'
+
+# Base response module
+require 'rbox/response/base'
+# Authentication response classes
+require 'rbox/response/authentication/ticket'
+require 'rbox/response/authentication/get_account_info'
+require 'rbox/response/authentication/verify_registration_email'
+require 'rbox/response/authentication/auth_token'
+require 'rbox/response/authentication/logout'
+require 'rbox/response/authentication/register_new_account'
+# Items response classes
+require 'rbox/response/items/account_tree'
+require 'rbox/response/items/folder'
+require 'rbox/response/items/file'
+
+
+module Rbox
+  class << self
+    def new(*arg)
+      Rbox::Client.new(*arg)
+    end
+  end
+end

data/lib/rbox/authentication.rb

@@ -0,0 +1,43 @@
+module Rbox
+  module Authentication
+
+    def get_ticket
+      response = action(:get_ticket)
+      Response::Ticket.new(response, self)
+    end
+
+    def get_auth_token
+      raise 'Ticket is require for this operation' unless ticket
+
+      response = action(:get_auth_token) do |req|
+        req.params[:ticket] = ticket        
+      end
+      Response::AuthToken.new(response, self)
+    end
+
+    def logout
+      response = action(:logout)
+      Response::Logout.new(response, self)
+    end
+
+    def register_new_user(login, password)
+      response = action(:register_new_user)
+      Response::RegisterNewUser.new(response, self)
+    end
+
+    def verify_registration_email
+      response = action(:verify_registration_email)
+      Response::VerifyRegistrationEmail.new(response, self)
+    end
+
+    def get_account_info
+      response = action(:get_account_info)
+      Response::GetAccountInfo.new(response, self)
+    end
+
+    def authorize_url
+      "https://www.box.net/api/1.0/auth/#{@ticket}"
+    end
+
+  end
+end

data/lib/rbox/client.rb

@@ -0,0 +1,20 @@
+module Rbox
+  class Client
+    include Connection
+    include Authentication
+    include Download
+    include Item
+
+    attr_accessor :config, :api_token, :auth_token, :ticket
+    attr_reader :connection
+
+    def initialize(options = {})
+      @config = options
+      @api_token = @config[:api_token]
+      @auth_token = @config[:auth_token]
+      @ticket = @config[:ticket]
+      @connection = default_connection
+    end
+
+  end
+end

data/lib/rbox/connection.rb

@@ -0,0 +1,31 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Rbox
+  module Connection
+
+  private
+    def action(action, options = {}, &block)
+      params = { :action => action.to_s }
+      params[:api_key] = api_token if api_token
+      params[:auth_token] = auth_token if auth_token
+      connection.get('/api/1.0/rest') do |req|
+        req.params = req.params.merge(params)
+        block.call(req) if block_given?
+      end
+    end
+
+    def default_connection
+      Faraday.new(:url => 'https://www.box.net/') do |builder|
+        builder.use Faraday::Response::ParseXml
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Response::Logger if @config[:logger]
+        builder.use Faraday::Adapter::NetHttp
+      end
+    end
+
+    def set_connection(*arg, &block)
+      @connection = Faraday.send(:new, *args, &block)
+    end
+  end
+end

data/lib/rbox/download.rb

@@ -0,0 +1,9 @@
+module Rbox
+  module Download
+
+    def download_url(file_id)
+      "https://www.box.net/api/1.0/download/#{auth_token}/#{file_id}"
+    end
+
+  end
+end

data/lib/rbox/item.rb

@@ -0,0 +1,43 @@
+module Rbox
+  module Item
+
+    def get_account_tree(options = { :folder_id => 0 })
+      raise 'Auth token and api key is require for this operation' unless auth_token and api_token
+
+      response = action(:get_account_tree) do |req|
+        req.params['params[]'] = 'nozip'
+        req.params.merge!(options)
+      end
+      Response::AccountTree.new(response, self)
+    end
+ 
+    def get_file_info(file_id, options = {} )
+      raise 'Auth token and api key is require for this operation' unless auth_token and api_token
+
+      response = action(:get_file_info) do |req|
+        req.params.merge!(options)
+        req.params[:file_id] = file_id
+      end
+
+      response_file = response.body['response']['info']
+      response_file['id'] = response_file['file_id']
+
+      Response::File.new(response_file, self)
+    end
+
+    def public_share(target_id, target_type = 'file')
+      response = action(:public_share) do |req|
+        req.params[:target] = target_type
+        req.params[:target_id] = target_id
+
+        # Yes, we need those empty strings
+        %w(password message emails[]).each do |key|
+          req.params[key] = ''
+        end
+      end
+
+      response.body['response']['public_name']
+    end
+
+  end
+end

data/lib/rbox/response/authentication/auth_token.rb

@@ -0,0 +1,25 @@
+module Rbox
+  module Response
+    class AuthToken
+      include Base
+
+      def initialize(*arg)
+        super(*arg)
+        @client.auth_token = auth_token
+      end
+
+      def auth_token
+        @body_response['auth_token']
+      end
+
+      def user
+        @body_response['user']
+      end
+
+      def attributes
+        { :user => user, :auth_token => auth_token }
+      end
+
+    end
+  end
+end

data/lib/rbox/response/authentication/get_account_info.rb

@@ -0,0 +1,16 @@
+module Rbox
+  module Response
+    class GetAccountInfo
+      include Base
+
+      def user
+        @body_response['user']
+      end
+
+      def attributes
+        { :user => user }
+      end
+
+    end
+  end
+end

data/lib/rbox/response/authentication/logout.rb

@@ -0,0 +1,7 @@
+module Rbox
+  module Response
+    class Logout
+      include Base
+    end
+  end
+end

data/lib/rbox/response/authentication/register_new_account.rb

@@ -0,0 +1,29 @@
+module Rbox
+  module Response
+    class RegisterNewAccount
+      include Base
+
+      def initialize(*arg)
+        super(*arg)
+        @client.auth_token = auth_token
+      end
+
+      def auth_token
+        @body_response['auth_token']
+      end
+
+      def user
+        @body_response['user']
+      end
+
+      def attributes
+        { :user => user, :auth_token => auth_token }
+      end
+
+      def success?
+        !!(status == 'successful_register')
+      end
+
+    end
+  end
+end

data/lib/rbox/response/authentication/ticket.rb

@@ -0,0 +1,29 @@
+module Rbox
+  module Response
+    class Ticket
+      include Base
+
+      def initialize(*arg)
+        super(*arg)
+        @client.ticket = ticket
+      end
+
+      def ticket
+        @body_response['ticket']
+      end
+
+      def authentization_url
+        "https://www.box.net/api/1.0/auth/#{ticket}"
+      end
+
+      def auth_token
+        @client.auth_token(ticket)
+      end
+
+      def attributes
+        { :ticket => @body_response['ticket'] }
+      end
+
+    end
+  end
+end

data/lib/rbox/response/authentication/verify_registration_email.rb

@@ -0,0 +1,7 @@
+module Rbox
+  module Response
+    class VerifyRegistrationEmail
+      include Base
+    end
+  end
+end

data/lib/rbox/response/base.rb

@@ -0,0 +1,24 @@
+module Rbox
+  module Response
+    module Base
+      def initialize(response, client)
+        @response = response
+        @body_response = response.body['response']
+        @client = client
+        raise "Response failure with status code \"#{status}\"" unless success?
+      end
+
+      def success?
+        !!(status =~ /_ok\z/)
+      end
+
+      def status
+        @body_response['status']
+      end
+
+      def method_missing(name, *args, &block)
+        @client.send(name, *args, &block)
+      end
+    end
+  end
+end

data/lib/rbox/response/items/account_tree.rb

@@ -0,0 +1,33 @@
+module Rbox
+  module Response
+    class AccountTree
+      include Base
+      include CollectNestedKey
+
+      def root_folder
+        @root_folder ||= Folder.new(@body_response['tree']['folder'], @client)
+      end
+      alias :tree :root_folder
+
+      def files
+        @files ||= collect_nested_key(@body_response['tree'], 'file').map {|f| File.new(f, @client) }
+      end
+
+      def folders
+        @folder ||= collect_nested_key(@body_response['tree'], 'folder').map {|f| Folder.new(f, @client) }
+      end
+
+      def to_array
+        root_folder.folders.map {|f| f.to_hash } + root_folder.files.map {|f| f.to_hash }
+      end
+      alias :to_a :to_array
+
+      def to_hash
+        root_folder.to_hash
+      end
+      alias :to_h :to_hash
+      alias :attributes :to_hash
+
+    end
+  end
+end

data/lib/rbox/response/items/file.rb

@@ -0,0 +1,57 @@
+module Rbox
+  module Response
+    class File
+
+      ATTRIBUTES = %w(id file_name shared sha1 size shared_link description user_id thumbnail small_thumbnail large_thumbnail larger_thumbnail preview_thumbnail permissions tags)
+
+      ATTRIBUTES.each do |attr_name|
+        define_method(attr_name) do
+          instance_variable_get(:@attributes)[attr_name]
+        end
+      end
+
+      %w(created updated).each do |attr_name|
+        define_method(attr_name) do
+          Time.at(instance_variable_get(:@attributes)[attr_name])
+        end
+      end
+
+      def initialize(attributes, client, parent_folder = nil)
+        @attributes = attributes.dup
+        @client = client
+        @parent_folder = parent_folder
+      end
+
+      def attributes
+        @attributes
+      end
+
+      def download_url
+        @client.download_url(id)
+      end
+
+      # public share
+      # https://www.box.net/api/1.0/rest?action=public_share&api_key=rrc1d3ntb53tt6b2vhail6rdtrsxov3v&auth_token=rpuis3lincpbyz60gyym8s3xhnc6gbcl&target=folder&target_id=709&password=&message=hey&emails[]=email@example.com&emails[]=email2@example.com
+      def public_share!
+        @public_name ||= @client.public_share(self.id, 'file')
+        true
+      end
+
+      def public_share_url
+        if @public_link.nil? || @public_link.empty?
+          public_share!
+          "https://www.box.net/s/#{@public_name}"
+        else
+          @public_link
+        end
+      end
+
+      def to_hash
+        hash = ATTRIBUTES.inject({}) {|h,k,v| h[k.to_sym]= @attributes[k]; h }
+        hash[:type] = 'file'
+        hash[:parent_folder_id] = @parent_folder.id if @parent_folder
+        hash
+      end
+    end
+  end
+end

data/lib/rbox/response/items/folder.rb

@@ -0,0 +1,64 @@
+module Rbox
+  module Response
+    class Folder
+
+      ATTRIBUTES = %w(id name description user_id shared shared_link permissions size file_count tags)
+
+      ATTRIBUTES.each do |attr_name|
+        define_method(attr_name) do
+          instance_variable_get(:@attributes)[attr_name]
+        end
+      end
+
+      %w(created updated).each do |attr_name|
+        define_method(attr_name) do
+          Time.at(instance_variable_get(:@attributes)[attr_name])
+        end
+      end
+
+      def initialize(attributes, client, parent_folder = nil)
+        @attributes = attributes.dup
+        @client = client
+
+        @parent_folder = parent_folder
+
+        @folders_attr = [@attributes['folders']['folder']].flatten rescue []
+        @attributes.delete('folders')
+
+        # lol, { files => { file => [file, ...] } }
+        @files_attr = [@attributes['files']['file']].flatten  rescue []
+        @attributes.delete('files')
+      end
+
+      def folders
+        @folders ||= @folders_attr.map {|f| Folder.new(f, @client, self) }
+      end
+
+      def create_folder(name, options = {})
+        options[:parent_id] = id
+        @client.create_folder(name, options)
+      end
+
+      def files
+        @files ||= @files_attr.map {|f| File.new(f, @client, self) }
+      end
+
+      def attributes
+        @attributes
+      end
+
+      def root?
+        id == '0'
+      end
+
+      def to_hash
+        hash = ATTRIBUTES.inject({}) {|h,k,v| h[k.to_sym]= @attributes[k]; h }
+        hash[:files]   = files.map {|f| f.to_hash }
+        hash[:folders] = folders.map {|f| f.to_hash }
+        hash[:type] = 'folder'
+        hash[:parent_folder_id] = @parent_folder.id if @parent_folder
+        hash
+      end
+    end
+  end
+end

data/lib/rbox/utils/collect_nested_key.rb

@@ -0,0 +1,26 @@
+module Rbox
+  module CollectNestedKey
+
+    def collect_nested_key(obj, key)
+      result = []
+
+      case obj
+      when Hash
+        if obj.key? key
+          result << obj[key]
+        else
+          obj.each do |k, child|
+            result += collect_nested_key(child, key)
+          end
+        end
+      when Array
+        obj.each do |child|
+          result += collect_nested_key(child, key)
+        end
+      end
+
+      result.flatten
+    end
+
+  end
+end

data/rbox.gemspec

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'faraday', '>= 0.7'
+  gem.add_dependency 'multi_xml', '~> 0.4.1'
+
+  gem.authors = ["Charles Barbier"]
+  gem.description = %q{A Ruby wrapper for box.com}
+  gem.email = ['unixcharles@gmail.com']
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'https://github.com/unixcharles/rbox'
+  gem.name = 'rbox'
+  gem.require_paths = ['lib']
+  gem.summary = %q{box.com API wrapper}
+  gem.test_files = `git ls-files -- {spec}/*`.split("\n")
+  gem.version = '0.1.0'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: rbox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Charles Barbier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70133377507860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70133377507860
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: &70133377507360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70133377507360
+description: A Ruby wrapper for box.com
+email:
+- unixcharles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- lib/rbox.rb
+- lib/rbox/authentication.rb
+- lib/rbox/client.rb
+- lib/rbox/connection.rb
+- lib/rbox/download.rb
+- lib/rbox/item.rb
+- lib/rbox/response/authentication/auth_token.rb
+- lib/rbox/response/authentication/get_account_info.rb
+- lib/rbox/response/authentication/logout.rb
+- lib/rbox/response/authentication/register_new_account.rb
+- lib/rbox/response/authentication/ticket.rb
+- lib/rbox/response/authentication/verify_registration_email.rb
+- lib/rbox/response/base.rb
+- lib/rbox/response/items/account_tree.rb
+- lib/rbox/response/items/file.rb
+- lib/rbox/response/items/folder.rb
+- lib/rbox/utils/collect_nested_key.rb
+- rbox.gemspec
+homepage: https://github.com/unixcharles/rbox
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: box.com API wrapper
+test_files: []