lti-ruby-box 1.14.1

data/lib/ruby-box/item.rb

@@ -0,0 +1,181 @@
+require 'time'
+require 'addressable/uri'
+
+module RubyBox
+  class Item
+
+    @@has_many = []
+    @@has_many_paginated = []
+
+    def initialize( session, raw_item )
+      @session = session
+      @raw_item = raw_item
+    end
+
+    def self.has_many(*keys)
+      keys.each {|key| @@has_many << key.to_s}
+    end
+
+    def self.has_many_paginated(*keys)
+      keys.each {|key| @@has_many_paginated << key.to_s}
+    end
+
+    def move_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)
+
+      self.name = name if name
+      self.parent = {"id" => folder_id}
+
+      update
+    end
+
+    def update
+      reload_meta unless etag
+
+      url = "#{RubyBox::API_URL}/#{resource_name}/#{id}"
+      uri = URI.parse(url)
+
+      request = Net::HTTP::Put.new(uri.path, {
+        "if-match" => etag,
+        "Content-Type" => 'application/json'
+      })
+      request.body = JSON.dump(serialize)
+
+      @raw_item = @session.request(uri, request)
+      self
+    end
+
+    def create
+      url = "#{RubyBox::API_URL}/#{resource_name}"
+      uri = URI.parse(url)
+      request = Net::HTTP::Post.new( uri.request_uri )
+      request.body = JSON.dump(@raw_item)
+      resp = @session.request(uri, request)
+      @raw_item = resp
+      self
+    end
+
+    def delete(opts={})
+      url = "#{RubyBox::API_URL}/#{resource_name}/#{id}"
+      url = "#{url}#{Addressable::URI.new(:query_values => opts).to_s}" unless opts.keys.empty?
+      resp = @session.delete( url )
+    end
+
+    def reload_meta
+      url = "#{RubyBox::API_URL}/#{resource_name}/#{@raw_item['id']}"
+      @raw_item = @session.get( url )
+      self
+    end
+
+    def method_missing(method, *args, &block)
+      key = method.to_s
+
+      # Support has many and paginated has many relationships.
+      return many(key) if @@has_many.include?(key)
+      return paginated(key, args[0] || 100, args[1] || 0, args[2]) if @@has_many_paginated.include?(key)
+      
+      # update @raw_item hash if this appears to be a setter.
+      setter = method.to_s.end_with?('=')
+      key = key[0...-1] if setter
+      @raw_item[key] = args[0] if setter and update_fields.include?(key)
+      
+      # we may have a mini version of the object loaded, fix this.
+      reload_meta if @raw_item[key].nil? and has_mini_format?
+
+      if @raw_item[key].kind_of?(Hash)
+        return RubyBox::Item.factory(@session, @raw_item[key])
+      elsif RubyBox::ISO_8601_TEST.match(@raw_item[key].to_s)
+        return Time.parse(@raw_item[key])
+      else
+        return @raw_item[key]
+      end
+    end
+
+    # see http://developers.box.com/docs/#folders-create-a-shared-link-for-a-folder
+    # for a list of valid options.
+    def create_shared_link(opts={})
+      raise UnshareableResource unless ['folder', 'file'].include?(type)
+
+      opts = {
+        access: 'open'
+      }.merge(opts) if opts
+
+      url = "#{RubyBox::API_URL}/#{resource_name}/#{id}"
+      uri = URI.parse(url)
+
+      request = Net::HTTP::Put.new(uri.path, {
+        "Content-Type" => 'application/json'
+      })
+
+      request.body = JSON.dump({
+        shared_link: opts
+      })
+
+      @raw_item = @session.request(uri, request)
+      self
+    end
+
+    def disable_shared_link(opts={})
+      create_shared_link(nil)
+    end
+
+    def shared_link
+      return nil unless @raw_item['shared_link']
+      RubyBox::Item.factory(@session, @raw_item['shared_link'].merge('type' => 'shared_link'))
+    end
+
+    def as_json(opts={})
+      @raw_item
+    end
+
+    protected
+
+    def self.factory(session, entry)
+      type = entry['type'] ? entry['type'].split('_').map(&:capitalize).join('').to_sym : nil
+      if RubyBox.constants.include? type
+        RubyBox.const_get(type).new(session, entry)
+      else
+        RubyBox::Item.new(session, entry)
+      end
+    end
+
+    def has_mini_format?
+      false
+    end
+
+    private
+
+    def many(key)
+      url = "#{RubyBox::API_URL}/#{resource_name}/#{id}/#{key}"
+      resp = @session.get( url )
+      resp['entries'].map {|i| RubyBox::Item.factory(@session, i)}
+    end
+
+    def paginated(key, item_limit=100, offset=0, fields=nil)
+      Enumerator.new do |yielder|
+        while true
+          url = "#{RubyBox::API_URL}/#{resource_name}/#{id}/#{key}?limit=#{item_limit}&offset=#{offset}"
+          url = "#{url}&fields=#{fields.map(&:to_s).join(',')}" if fields
+          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 serialize
+      update_fields.inject({}) {|hash, field| hash[field] = @raw_item[field]; hash}
+    end
+
+    def update_fields
+      ['name', 'description', 'parent']
+    end
+
+
+  end
+end

data/lib/ruby-box/login_token.rb

@@ -0,0 +1,9 @@
+module RubyBox
+  class LoginToken < Item
+
+    def resource_name
+      'login_tokens'
+    end
+
+  end
+end

data/lib/ruby-box/session.rb

@@ -0,0 +1,137 @@
+require 'oauth2'
+
+module RubyBox
+  class Session
+
+    OAUTH2_URLS = {
+      :site => 'https://www.box.com',
+      :authorize_url => "/api/oauth2/authorize",
+      :token_url => "/api/oauth2/token"
+    }
+
+    def initialize(opts={}, backoff=0.1)
+
+      @backoff = backoff # try not to excessively hammer API.
+
+      if opts[:client_id]
+        @oauth2_client = OAuth2::Client.new(opts[:client_id], opts[:client_secret], OAUTH2_URLS.dup)
+        @access_token = OAuth2::AccessToken.new(@oauth2_client, opts[:access_token]) if opts[:access_token]
+        @refresh_token = opts[:refresh_token]
+        @as_user = opts[:as_user]
+      else # Support legacy API for historical reasons.
+        @api_key = opts[:api_key]
+        @auth_token = opts[:auth_token]
+      end
+    end
+
+    def authorize_url(redirect_uri, state=nil)
+      opts = { :redirect_uri => redirect_uri }
+      opts[:state] = state if state
+
+      @oauth2_client.auth_code.authorize_url(opts)
+    end
+
+    def get_access_token(code)
+      @access_token = @oauth2_client.auth_code.get_token(code)
+    end
+
+    def refresh_token(refresh_token)
+      refresh_access_token_obj = OAuth2::AccessToken.new(@oauth2_client, @access_token.token, {'refresh_token' => refresh_token})
+      @access_token = refresh_access_token_obj.refresh!
+    end
+
+    def build_auth_header
+      "BoxAuth api_key=#{@api_key}&auth_token=#{@auth_token}"
+    end
+
+    def get(url, raw=false)
+      uri = URI.parse(url)
+      request = Net::HTTP::Get.new( uri.request_uri )
+      resp = request( uri, request, raw )
+    end
+
+    def delete(url, raw=false)
+      uri = URI.parse(url)
+      request = Net::HTTP::Delete.new( uri.request_uri )
+      resp = request( uri, request, raw )
+    end
+
+    def request(uri, request, raw=false, retries=0)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.ssl_version = :SSLv3
+      #http.set_debug_output($stdout)
+
+      if @access_token
+        request.add_field('Authorization', "Bearer #{@access_token.token}")
+      else
+        request.add_field('Authorization', build_auth_header)
+      end
+
+
+      request.add_field('As-User', "#{@as_user}") if @as_user
+
+      response = http.request(request)
+
+      if response.is_a? Net::HTTPNotFound
+        raise RubyBox::ObjectNotFound
+      end
+
+      # Got unauthorized (401) status, try to refresh the token
+      if response.code.to_i == 401 and @refresh_token and retries == 0
+        refresh_token(@refresh_token)
+        return request(uri, request, raw, retries + 1)
+      end
+
+      sleep(@backoff) # try not to excessively hammer API.
+
+      handle_errors( response, raw )
+    end
+
+    def do_stream(url, opts)
+      params = {
+        :content_length_proc => opts[:content_length_proc],
+        :progress_proc => opts[:progress_proc]
+      }
+
+      if @access_token
+        params['Authorization'] = "Bearer #{@access_token.token}"
+      else
+        params['Authorization'] = build_auth_header
+      end
+
+      params['As-User'] = @as_user if @as_user
+
+      open(url, params)
+    end
+
+    def handle_errors( response, raw )
+      status = response.code.to_i
+      body = response.body
+      begin
+        parsed_body = JSON.parse(body)
+      rescue
+        msg = body.nil? || body.empty? ? "no data returned" : body
+        parsed_body = { "message" =>  msg }
+      end
+
+      # status is used to determine whether
+      # we need to refresh the access token.
+      parsed_body["status"] = status
+
+      case status / 100
+      when 3
+        # 302 Found. We should return the url
+        parsed_body["location"] = response["Location"] if status == 302
+      when 4
+        raise(RubyBox::ItemNameInUse.new(parsed_body, status, body), parsed_body["message"]) if parsed_body["code"] == "item_name_in_use"
+        raise(RubyBox::AuthError.new(parsed_body, status, body), parsed_body["message"]) if parsed_body["code"] == "unauthorized" || status == 401
+        raise(RubyBox::RequestError.new(parsed_body, status, body), parsed_body["message"])
+      when 5
+        raise(RubyBox::ServerError.new(parsed_body, status, body), parsed_body["message"])
+      end
+      raw ? body : parsed_body
+    end
+  end
+end

data/lib/ruby-box/shared_link.rb

@@ -0,0 +1,10 @@
+module RubyBox
+  class SharedLink < Item
+    
+    private
+    
+    def has_mini_format?
+      false
+    end
+  end
+end

data/lib/ruby-box/user.rb

@@ -0,0 +1,16 @@
+module RubyBox
+  class User < Item
+    
+    def enterprise
+      resp = @session.get( "#{RubyBox::API_URL}/users/#{id}?fields=enterprise" )
+      resp["enterprise"]
+    end
+    
+    private
+
+    def resource_name
+      'users'
+    end
+    
+  end
+end

data/lib/ruby-box/web_link.rb

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

data/lti-ruby-box.gemspec

@@ -0,0 +1,101 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "lti-ruby-box"
+  s.version = "1.14.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Attachments.me", "wbhumphrey"]
+  s.date = "2014-04-08"
+  s.description = "ruby gem for box.com 2.0 api"
+  s.email = "brad@instructure.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "lib/ruby-box.rb",
+    "lib/ruby-box/client.rb",
+    "lib/ruby-box/collaboration.rb",
+    "lib/ruby-box/comment.rb",
+    "lib/ruby-box/discussion.rb",
+    "lib/ruby-box/event.rb",
+    "lib/ruby-box/event_response.rb",
+    "lib/ruby-box/exceptions.rb",
+    "lib/ruby-box/file.rb",
+    "lib/ruby-box/folder.rb",
+    "lib/ruby-box/item.rb",
+    "lib/ruby-box/session.rb",
+    "lib/ruby-box/shared_link.rb",
+    "lib/ruby-box/user.rb",
+    "lib/ruby-box/web_link.rb",
+    "lib/ruby-box/login_token.rb",
+    "lti-ruby-box.gemspec",
+    # "spec/client_spec.rb",
+    # "spec/event_spec.rb",
+    # "spec/file_spec.rb",
+    # "spec/fixtures/comment_create.json",
+    # "spec/fixtures/events.json",
+    # "spec/fixtures/me.json",
+    # "spec/fixtures/users.json",
+    # "spec/folder_spec.rb",
+    # "spec/helper/account.example",
+    # "spec/helper/account.rb",
+    # "spec/integration_spec.rb",
+    # "spec/item_spec.rb",
+    # "spec/me_spec.rb",
+    # "spec/session_spec.rb",
+    # "spec/spec_helper.rb",
+    # "spec/users_spec.rb"
+  ]
+  s.homepage = "https://github.com/wbhumphrey/ruby-box"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "ruby gem for box.com 2.0 api"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<multipart-post>, [">= 0"])
+      s.add_runtime_dependency(%q<oauth2>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<addressable>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+    else
+      s.add_dependency(%q<multipart-post>, [">= 0"])
+      s.add_dependency(%q<oauth2>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<addressable>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<multipart-post>, [">= 0"])
+    s.add_dependency(%q<oauth2>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<addressable>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+  end
+end
+