lti-ruby-box 1.14.1

data/Rakefile

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "lti-ruby-box"
+  gem.homepage = "https://github.com/wbhumphrey/ruby-box"
+  gem.license = "MIT"
+  gem.summary = %Q{ruby gem for box.com 2.0 api}
+  gem.description = %Q{ruby gem for box.com 2.0 api}
+  gem.email = "brad@instructure.com"
+  gem.authors = ["Attachments.me", "wbhumphrey"]
+  gem.files.exclude 'spec/*.test'
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+1.14.0

data/lib/ruby-box.rb

@@ -0,0 +1,22 @@
+require 'ruby-box/client'
+require 'ruby-box/session'
+
+require 'ruby-box/item'
+require 'ruby-box/file'
+require 'ruby-box/folder'
+require 'ruby-box/user'
+require 'ruby-box/comment'
+require 'ruby-box/collaboration'
+require 'ruby-box/discussion'
+require 'ruby-box/exceptions'
+require 'ruby-box/event_response'
+require 'ruby-box/event'
+require 'ruby-box/web_link'
+require 'ruby-box/shared_link'
+require 'ruby-box/login_token'
+
+module RubyBox
+  API_URL = 'https://api.box.com/2.0'
+  UPLOAD_URL = 'https://upload.box.com/api/2.0'
+  ISO_8601_TEST = Regexp.new(/^[0-9]{4}-[0-9]{2}-[0-9]{2}T/)
+end

data/lib/ruby-box/client.rb

@@ -0,0 +1,167 @@
+require 'uri'
+require 'net/https'
+require 'json'
+require 'net/http/post/multipart'
+require 'open-uri'
+
+module RubyBox
+  class Client
+
+    def initialize(session)
+      @session = session
+    end
+
+    def root_folder
+      folder_by_id('0')
+    end
+
+    def folder_by_id(id)
+      folder = Folder.new(@session, {'id' => id})
+      folder.reload_meta
+    end
+
+    def folder(path='/')
+      path = path.sub(/(^\.$)|(^\.\/)/, '') if path # handle folders with leading '.'
+      return root_folder if ['', '/'].member?(path)
+      folder_from_split_path( split_path(path) )
+    end
+
+    def file_by_id(id)
+      file = File.new(@session, {'id' => id})
+      file.reload_meta
+    end
+
+    def file(path)
+      path = split_path( path.sub(/^\.\//, '') )
+      file_name = path.pop
+      folder = folder_from_split_path( path )
+      folder.files(file_name).first if folder
+    end
+
+    def item(path)
+      path = split_path( path.sub(/^\.\//, '') )
+      item_name = path.pop
+      folder = folder_from_split_path( path )
+
+      folder.items.select do |item|
+        item.instance_variable_get(:@raw_item)['name'] and item.name == item_name
+      end.first
+    end
+
+    def download(path)
+      file = file(path)
+      file.download if file
+    end
+
+    def stream(path, opts={})
+      file = file(path)
+      file.stream(opts) if file
+    end
+
+    def search(query, item_limit=100, offset=0)
+      Enumerator.new do |yielder|
+        while true
+          url = "#{RubyBox::API_URL}/search?query=#{URI::encode(query)}&limit=#{item_limit}&offset=#{offset}"
+          resp = @session.get( url )
+          resp['entries'].each do |entry|
+            yielder.yield(RubyBox::Item.factory(@session, entry))
+          end
+          offset += resp['entries'].count
+          break if resp['offset'].to_i + resp['limit'].to_i >= resp['total_count'].to_i
+        end
+      end
+    end
+
+    def create_folder(path)
+      folder = root_folder
+      folder_names = split_path(path)
+      folder_names.each do |folder_name|
+        new_folder = folder.folders(folder_name).first        
+        if !new_folder
+          begin
+            new_folder = folder.create_subfolder(folder_name)
+          rescue RubyBox::ItemNameInUse => e
+            new_folder = folder.folders(folder_name).first
+          end
+        end
+        folder = new_folder
+      end
+      folder
+    end
+
+    def upload_data(path, data, overwrite=true)
+      path = split_path(path)
+      file_name = path.pop
+      folder = create_folder(path.join('/'))
+      folder.upload_file(file_name, data, overwrite) if folder
+    end
+
+    def upload_file(local_path, remote_path, overwrite=true)
+      folder = create_folder( remote_path )
+      upload_file_to_folder(local_path, folder, overwrite)
+    end
+
+    def upload_file_by_folder_id(local_path, folder_id, overwrite=true)
+      folder = folder_by_id(folder_id)
+      upload_file_to_folder(local_path, folder, overwrite)
+    end
+
+    def split_path(path)
+      path.gsub!(/(^\/)|(\/$)/, '')
+      path.split('/')
+    end
+
+    def event_response(stream_position=0, stream_type=:all, limit=100)
+      q = fmt_events_args stream_position, stream_type, limit
+      url = "#{RubyBox::API_URL}/events?#{q}"
+      resp = @session.get( url )
+      EventResponse.new(@session, resp)
+    end
+
+    def me
+      resp = @session.get( "#{RubyBox::API_URL}/users/me" )
+      User.new(@session, resp)
+    end
+
+    def users(filter_term = "", limit = 100, offset = 0)
+      url = "#{RubyBox::API_URL}/users?filter_term=#{URI::encode(filter_term)}&limit=#{limit}&offset=#{offset}"
+      resp = @session.get( url )
+      resp['entries'].map do |entry|
+        RubyBox::Item.factory(@session, entry)
+      end
+    end
+
+    def login_token
+      RubyBox::LoginToken.new(@session, {}).create
+    end
+
+    private
+
+    def upload_file_to_folder(local_path, folder, overwrite)
+      file_name = local_path.split('/').pop
+      return unless folder
+      ::File.open(local_path, 'rb') do |data|
+        folder.upload_file(file_name, data, overwrite)
+      end
+    end
+
+    def folder_from_split_path(path)
+      folder = root_folder
+      path.each do |folder_name|
+        folder = folder.folders(folder_name).first
+        return nil unless folder
+      end
+      folder
+    end
+
+    def fmt_events_args(stream_position, stream_type, limit)
+      unless stream_position.to_s == 'now'
+        stream_position = stream_position.kind_of?(Numeric) ? stream_position : 0
+      end
+      stream_type = [:all, :changes, :sync, :admin_logs].include?(stream_type) ? stream_type : :all
+      limit = limit.kind_of?(Fixnum) ? limit : 100
+      "stream_position=#{stream_position}&stream_type=#{stream_type}&limit=#{limit}"
+    end
+    
+  end
+end

data/lib/ruby-box/collaboration.rb

@@ -0,0 +1,19 @@
+module RubyBox
+  class Collaboration < Item
+
+    private
+
+    def resource_name
+      'collaborations'
+    end
+
+    def update_fields
+      ['role', 'status']
+    end
+
+    def has_mini_format?
+      true
+    end
+
+  end
+end

data/lib/ruby-box/comment.rb

@@ -0,0 +1,14 @@
+module RubyBox
+  class Comment < Item
+    
+    private
+
+    def resource_name
+      'comments'
+    end
+
+    def has_mini_format?
+      true
+    end
+  end
+end

data/lib/ruby-box/discussion.rb

@@ -0,0 +1,15 @@
+module RubyBox
+  class Discussion < Item
+    has_many :comments
+
+    private
+
+    def resource_name
+      'discussions'
+    end
+
+    def has_mini_format?
+      true
+    end
+  end
+end

data/lib/ruby-box/event.rb

@@ -0,0 +1,4 @@
+module RubyBox
+  class Event < Item
+  end
+end

data/lib/ruby-box/event_response.rb

@@ -0,0 +1,17 @@
+module RubyBox
+  class EventResponse < Item
+
+    def events
+      @events ||= entries.collect {|ev|
+        RubyBox::Event.new(@session, ev)
+      }
+    end
+
+    private
+
+    def resource_name
+      'events'
+    end
+    
+  end
+end

data/lib/ruby-box/exceptions.rb

@@ -0,0 +1,22 @@
+module RubyBox 
+  class RubyBoxError < StandardError
+    attr_accessor :body, :status
+
+    def initialize(error_json, status, body)
+      @status = status
+      @body = body
+      @error_json = error_json
+    end
+
+    def [](key)
+      @error_json[key]
+    end
+  end
+
+  class ObjectNotFound < StandardError; end
+  class AuthError < RubyBoxError; end
+  class RequestError < RubyBoxError; end
+  class ServerError < RubyBoxError; end
+  class ItemNameInUse < RubyBoxError; end
+  class UnshareableResource < StandardError; end
+end

data/lib/ruby-box/file.rb

@@ -0,0 +1,96 @@
+module RubyBox
+  class File < Item
+
+    has_many :comments
+
+    def download
+      resp = stream.read
+    end
+
+    def download_url
+      @session.get( file_content_url )["location"]
+    end
+
+    def copy_to( folder_id, name=nil )
+
+      # Allow either a folder_id or a folder object
+      # to be passed in.
+      folder_id = folder_id.id if folder_id.instance_of?(RubyBox::Folder)
+
+      uri = URI.parse( "#{RubyBox::API_URL}/#{resource_name}/#{id}/copy" )
+      request = Net::HTTP::Post.new( uri.request_uri )
+      request.body = JSON.dump({
+        "parent" => {"id" => folder_id},
+        "name" => name
+      })
+
+      resp = @session.request(uri, request)
+    end
+
+    def stream( opts={} )
+      open(download_url, opts)
+    end
+
+    def upload_content( data )
+      url = "#{RubyBox::UPLOAD_URL}/#{resource_name}/content"
+      uri = URI.parse(url)
+      request = Net::HTTP::Post::Multipart.new(uri.path, {
+        "filename" => UploadIO.new(data, "application/pdf", name),
+        "folder_id" => parent.id
+      })
+
+      resp = @session.request(uri, request)
+      if resp['entries']
+        @raw_item = resp['entries'][0]
+      else
+        @raw_item = resp
+      end
+      self
+    end
+
+    def update_content( data )
+
+      url = "#{RubyBox::UPLOAD_URL}/#{resource_name}/#{id}/content"
+      uri = URI.parse(url)
+
+      request = Net::HTTP::Post::Multipart.new(uri.path, {
+        "filename" => prepare_upload(data, name),
+        "folder_id" => parent.id
+      }, {"if-match" => etag })
+
+      resp = @session.request(uri, request)
+      if resp['entries']
+        @raw_item = resp['entries'][0]
+      else
+        @raw_item = resp
+      end
+      self
+    end
+
+    def create_comment(message)
+      RubyBox::Comment.new(@session, {
+          'item' => {'id' => id, 'type' => type},
+          'message' => message
+      }).create
+    end
+
+    private
+    def file_content_url
+      "#{RubyBox::API_URL}/#{resource_name}/#{id}/content"
+    end
+    
+
+    def resource_name
+      'files'
+    end
+
+    def has_mini_format?
+      true
+    end
+
+    def prepare_upload(data, fname)
+      UploadIO.new(data, "application/pdf", fname)
+    end
+
+  end
+end

data/lib/ruby-box/folder.rb

@@ -0,0 +1,113 @@
+module RubyBox
+  class Folder < Item
+
+    has_many :discussions
+    has_many :collaborations
+    has_many_paginated :items
+
+    def files(name=nil, item_limit=100, offset=0, fields=nil)
+      items_by_type(RubyBox::File, name, item_limit, offset, fields)
+    end
+
+    def folders(name=nil, item_limit=100, offset=0, fields=nil)
+      items_by_type(RubyBox::Folder, name, item_limit, offset, fields)
+    end
+
+    def upload_file(filename, data, overwrite=true)
+      file = RubyBox::File.new(@session, {
+        'name' => filename,
+        'parent' => RubyBox::Folder.new(@session, {'id' => id})
+      })
+
+      begin
+        resp = file.upload_content(data) #write a new file. If there is a conflict, update the conflicted file.
+      rescue RubyBox::ItemNameInUse => e
+        
+        # if overwrite flag is false, simply raise exception.
+        raise e unless overwrite
+
+        # otherwise let's attempt to overwrite the file.
+        data.rewind
+
+        # The Box API occasionally does not return
+        # context info for an ItemNameInUse exception.
+        # This is a workaround around:
+        begin
+          # were were given context information about this conflict?
+          file = RubyBox::File.new(@session, {
+            'id' => e['context_info']['conflicts'][0]['id']
+          })
+        rescue
+          # we were not given context information about this conflict.
+          # attempt to lookup the file.
+          file = files(filename, 1000).pop
+        end
+
+        raise e unless file # re-raise the ItemNameInUse exception.
+        resp = file.update_content( data )
+      end
+    end
+
+    def create_subfolder(name)
+      url = "#{RubyBox::API_URL}/#{resource_name}"
+      uri = URI.parse(url)
+      request = Net::HTTP::Post.new( uri.request_uri )
+      request.body = JSON.dump({ "name" => name, "parent" => {"id" => id} })
+      resp = @session.request(uri, request)
+      RubyBox::Folder.new(@session, resp)
+    end
+
+    # see http://developers.box.com/docs/#collaborations-collaboration-object
+    # for a list of valid roles.
+    def create_collaboration(email, role=:viewer)
+      RubyBox::Collaboration.new(@session, {
+          'item' => {'id' => id, 'type' => type},
+          'accessible_by' => {'login' => email},
+          'role' => role.to_s
+      }).create
+    end
+
+    # see http://developers.box.com/docs/#folders-copy-a-folder
+    # for a description of the behavior
+    def copy_to(destination, name=nil)
+      parent = {'parent' => {'id' => destination.id}}
+      parent.merge!('name' => name) if name
+
+      RubyBox::Folder.new(@session, post(folder_method(:copy), parent))
+    end
+
+    private
+    def post(extra_url, body)
+      uri = URI.parse("#{RubyBox::API_URL}/#{extra_url}")
+      post = Net::HTTP::Post.new(uri.request_uri)
+      post.body = JSON.dump(body)
+      @session.request(uri, post)
+    end
+
+    def resource_name
+      'folders'
+    end
+
+    def folder_method(method)
+      "folders/#{id}/#{method}"
+    end
+
+    def has_mini_format?
+      true
+    end
+
+    def items_by_type(type, name, item_limit, offset, fields)
+
+      # allow paramters to be set via
+      # a hash rather than a list of arguments.
+      if name.is_a?(Hash)
+        return items_by_type(type, name[:name], name[:item_limit], name[:offset], name[:fields])
+      end
+
+      items(item_limit, offset, fields).select do |item|
+        item.kind_of? type and (name.nil? or item.name.casecmp(name) == 0)
+      end
+
+    end
+  end
+end