boxr 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c4c27adff340e29abba4bcf0faad07015ac528c
-  data.tar.gz: 683c1ef609710dc2bb9c661562c94e461c4f2766
+  metadata.gz: b149bf857a1d64b35578d649c769792c9569e1c2
+  data.tar.gz: 1cba489db37903b1ceea8f90508687baf76521da
 SHA512:
-  metadata.gz: e315eb590f313753ba1c01f171ab9fda6f463f98372e16d9c4bf27a3c3a34bdaf0e04797e215cdbaafef4b6992417cd7b62281a547eeab156929cc87e0387bdb
-  data.tar.gz: 4da05a5a7890a733219eddf0e8e1e5ae3d36391825f5bfcc616e1ebbc09dbe22254bf8836ab6773d291a13748281661d88e33863962c2fd8e2ac1bf05e2e3a51
+  metadata.gz: 6a9ff438d8b6a582d3e52bdea63457b874377b5c7290b945a3430241d308aa051cf6c9e0b4c8d929c273f411582d343f1c3ff7f79b3e217fccd27d61fe882e3b
+  data.tar.gz: b6ffbfe77e2060e9d7a01d60eec9aca993181f22353282da8df4e86185d357f96eb4b0edff5af74adfb924bc5768a81dc20f61c2cf2e21882ebd8ba547d336f1

data/README.md

@@ -3,7 +3,10 @@ Boxr is a Ruby client library for the Box V2 Content API that covers 100% of the
 
 The purpose of this gem is to provide a clear, efficient, and intentional method of interacting with the Box Content API. As with any SDK that wraps a REST API, it is important to fully understand the Box Content API at the REST endpoint level.  You are strongly encouraged to read through the Box documentation located [here](https://developers.box.com/docs/).
 
-The full RubyDocs for Boxr can be found [here](http://www.rubydoc.info/gems/boxr/Boxr/Client).  You are also encouraged to rely heavily on the source code found in the [lib/boxr](https://github.com/cburnette/boxr/tree/master/lib/boxr) directory of this gem, as well as on the integration test found [here](https://github.com/cburnette/boxr/blob/master/spec/boxr_spec.rb).
+The full RubyDocs for Boxr can be found [here](http://www.rubydoc.info/gems/boxr/Boxr/Client).  You are also encouraged to rely heavily on the source code found in the [lib/boxr](https://github.com/cburnette/boxr/tree/master/lib/boxr) directory of this gem, as well as on the integration tests found [here](https://github.com/cburnette/boxr/blob/master/spec/boxr_spec.rb).
+
+## Requirements
+This gem requires Ruby 2.0.0 or higher.  The integration tests are currently being run using MRI Ruby 2.0.0-p643 and MRI Ruby 2.2.0.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -103,7 +106,7 @@ puts "Shared Link: #{file.shared_link.url}"
 ```ruby
 #NOTE: these are all module methods
 
-Boxr::oauth_url(state, response_type: "code", scope: nil, folder_id: nil, box_client_id: ENV['BOX_CLIENT_ID'])
+Boxr::oauth_url(state, host: "app.box.com", response_type: "code", scope: nil, folder_id: nil, box_client_id: ENV['BOX_CLIENT_ID'])
 
 Boxr::get_tokens(code, grant_type: "authorization_code", username: nil, box_client_id: ENV['BOX_CLIENT_ID'], box_client_secret: ENV['BOX_CLIENT_SECRET'])
 
@@ -221,11 +224,11 @@ pending_collaborations()
 ```
 #### [Events](https://developers.box.com/docs/#events)
 ```ruby
-user_events(stream_position, stream_type: :all, limit: 100)
+user_events(stream_position, stream_type: :all, limit: 800)
       
-enterprise_events(created_after: nil, created_before: nil, stream_position: 0, event_type: nil, limit: 100)
+enterprise_events(created_after: nil, created_before: nil, stream_position: 0, event_type: nil, limit: 500)
 
-enterprise_events_stream(initial_stream_position, event_type: nil, limit: 100, refresh_period: 5)
+enterprise_events_stream(initial_stream_position, event_type: nil, limit: 500, refresh_period: 300)
 ```
 #### [Shared Items](https://developers.box.com/docs/#shared-items)
 ```ruby

data/boxr.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "oj", "~> 2.11"
   spec.add_runtime_dependency "httpclient", "~> 2.5"
   spec.add_runtime_dependency "hashie", "~> 3.3"
+  spec.add_runtime_dependency "addressable", "~> 2.3"
 end

data/lib/boxr.rb

@@ -1,6 +1,7 @@
 require 'oj'
 require 'httpclient'
 require 'hashie'
+require 'addressable/template'
 
 require 'boxr/version'
 require 'boxr/errors'
@@ -57,4 +58,4 @@ module Boxr
     BOX_CLIENT.transparent_gzip_decompression = true
     nil
   end
-end
+end

data/lib/boxr/auth.rb

@@ -1,9 +1,13 @@
 module Boxr
 
-  def self.oauth_url(state, response_type: "code", scope: nil, folder_id: nil, box_client_id: ENV['BOX_CLIENT_ID'])
-    uri = "https://app.box.com/api/oauth2/authorize?response_type=#{response_type}&state=#{state}&client_id=#{box_client_id}"
-    uri = uri + "&scope=#{scope}" unless scope.nil?
-    uri = uri + "&folder_id=#{folder_id}" unless folder_id.nil?
+  def self.oauth_url(state, host: "app.box.com", response_type: "code", scope: nil, folder_id: nil, box_client_id: ENV['BOX_CLIENT_ID'])
+    template = Addressable::Template.new("https://{host}/api/oauth2/authorize{?query*}")
+
+    query = {"response_type" => "#{response_type}", "state" => "#{state}", "client_id" => "#{box_client_id}"}
+    query["scope"] = "#{scope}" unless scope.nil?
+    query["folder_id"] = "#{folder_id}" unless folder_id.nil?
+    
+    uri = template.expand({"host" => "#{host}", "query" => query})
     uri
   end
 
@@ -32,6 +36,8 @@ module Boxr
   private
 
   def self.auth_post(uri, body)
+    uri = Addressable::URI.encode(uri)
+
     res = BOX_CLIENT.post(uri, body: body)
 
     if(res.status==200)

data/lib/boxr/client.rb

@@ -49,6 +49,8 @@ module Boxr
 
     GROUP_FIELDS = [:type, :id, :name, :created_at, :modified_at]
     GROUP_FIELDS_QUERY = GROUP_FIELDS.join(',')
+
+    VALID_COLLABORATION_ROLES = ['editor','viewer','previewer','uploader','previewer uploader','viewer uploader','co-owner','owner']
     
 
     def initialize(access_token=ENV['BOX_DEVELOPER_TOKEN'], refresh_token: nil, box_client_id: ENV['BOX_CLIENT_ID'], box_client_secret: ENV['BOX_CLIENT_SECRET'], 
@@ -67,13 +69,15 @@ module Boxr
 
     private
 
-    def get(uri, query: nil, success_codes: [200], process_response: true, if_match: nil, box_api_header: nil)
+    def get(uri, query: nil, success_codes: [200], process_response: true, if_match: nil, box_api_header: nil, follow_redirect: true)
+      uri = Addressable::URI.encode(uri)
+
       res = with_auto_token_refresh do
         headers = standard_headers
         headers['If-Match'] = if_match unless if_match.nil?
         headers['BoxApi'] = box_api_header unless box_api_header.nil?
 
-        BOX_CLIENT.get(uri, query: query, header: headers)
+        BOX_CLIENT.get(uri, query: query, header: headers, follow_redirect: follow_redirect)
       end
 
       check_response_status(res, success_codes)
@@ -85,7 +89,8 @@ module Boxr
       end
     end
 
-    def get_all_with_pagination(uri, query: {}, offset: 0, limit: DEFAULT_LIMIT)
+    def get_all_with_pagination(uri, query: {}, offset: 0, limit: DEFAULT_LIMIT, follow_redirect: true)
+      uri = Addressable::URI.encode(uri)
       entries = []
 
       begin
@@ -93,7 +98,7 @@ module Boxr
         query[:offset] = offset
         res = with_auto_token_refresh do
           headers = standard_headers
-          BOX_CLIENT.get(uri, query: query, header: headers)
+          BOX_CLIENT.get(uri, query: query, header: headers, follow_redirect: follow_redirect)
         end
         
         if (res.status==200)
@@ -111,6 +116,7 @@ module Boxr
     end
 
     def post(uri, body, query: nil, success_codes: [201], process_body: true, content_md5: nil, content_type: nil, if_match: nil)
+      uri = Addressable::URI.encode(uri)
       body = Oj.dump(body) if process_body
 
       res = with_auto_token_refresh do
@@ -128,6 +134,8 @@ module Boxr
     end
 
     def put(uri, body, query: nil, success_codes: [200], content_type: nil, if_match: nil)
+      uri = Addressable::URI.encode(uri)
+
       res = with_auto_token_refresh do
         headers = standard_headers
         headers['If-Match'] = if_match unless if_match.nil?
@@ -142,6 +150,8 @@ module Boxr
     end
 
     def delete(uri, query: nil, success_codes: [204], if_match: nil)
+      uri = Addressable::URI.encode(uri)
+
       res = with_auto_token_refresh do
         headers = standard_headers
         headers['If-Match'] = if_match unless if_match.nil?
@@ -155,6 +165,8 @@ module Boxr
     end
 
     def options(uri, body, success_codes: [200])
+      uri = Addressable::URI.encode(uri)
+
       res = with_auto_token_refresh do
         headers = standard_headers
         BOX_CLIENT.options(uri, body: Oj.dump(body), header: headers)

data/lib/boxr/collaborations.rb

@@ -18,7 +18,7 @@ module Boxr
 
       attributes = {item: {id: folder_id, type: :folder}}
       attributes[:accessible_by] = accessible_by
-      attributes[:role] = role
+      attributes[:role] = validate_role(role)
 
       collaboration, response = post(COLLABORATIONS_URI, attributes, query: query)
       collaboration
@@ -28,7 +28,7 @@ module Boxr
       collaboration_id = ensure_id(collaboration)
       uri = "#{COLLABORATIONS_URI}/#{collaboration_id}"
       attributes = {}
-      attributes[:role] = role unless role.nil?
+      attributes[:role] = validate_role(role) unless role.nil?
       attributes[:status] = status unless status.nil?
 
       updated_collaboration, response = put(uri, attributes)
@@ -62,5 +62,22 @@ module Boxr
     end
 
 
+    private
+    
+    def validate_role(role)
+      case role
+      when :previewer_uploader
+        role = 'previewer uploader'
+      when :viewer_uploader
+        role = 'viewer uploader'
+      when :co_owner
+        role = 'co-owner'
+      end
+
+      role = role.to_s
+      raise BoxrError.new(boxr_message: "Invalid collaboration role: '#{role}'") unless VALID_COLLABORATION_ROLES.include?(role)
+      
+      role
+    end
   end
 end

data/lib/boxr/files.rb

@@ -52,7 +52,7 @@ module Boxr
         uri = "#{FILES_URI}/#{file_id}/content"
         query = {}
         query[:version] = version unless version.nil?
-        body_json, response = get(uri, query: query, success_codes: [302,202])
+        body_json, response = get(uri, query: query, success_codes: [302,202], follow_redirect: false) #we don't want httpclient to automatically follow the redirect; we need to grab it
 
         if(response.status==302)
           location = response.header['Location'][0]

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "0.18.0"
+  VERSION = "0.19.0"
 end

data/spec/boxr_spec.rb

@@ -61,6 +61,8 @@ describe Boxr::Client do
     end
   end
 
+  #use this command to just execute this scenario
+  #rake spec SPEC_OPTS="-e \"invokes folder operations"\"
   it 'invokes folder operations' do
     puts "get folder using path"
     folder = BOX_CLIENT.folder_from_path(TEST_FOLDER_NAME)
@@ -125,6 +127,7 @@ describe Boxr::Client do
     expect(result).to eq({})
   end
 
+  #rake spec SPEC_OPTS="-e \"invokes file operations"\"
   it "invokes file operations" do
     puts "upload a file"
     new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder)
@@ -216,6 +219,7 @@ describe Boxr::Client do
     expect(result).to eq({})
   end
 
+  #rake spec SPEC_OPTS="-e \"invokes user operations"\"
   it "invokes user operations" do 
     puts "inspect current user"
     user = BOX_CLIENT.current_user
@@ -244,6 +248,7 @@ describe Boxr::Client do
     expect(result).to eq({})
   end
 
+  #rake spec SPEC_OPTS="-e \"invokes group operations"\"
   it "invokes group operations" do
     puts "create group"
     group = BOX_CLIENT.create_group(TEST_GROUP_NAME)
@@ -305,6 +310,7 @@ describe Boxr::Client do
     expect(response).to eq({})
   end
 
+  #rake spec SPEC_OPTS="-e \"invokes comment operations"\"
   it "invokes comment operations" do 
     new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder)
     test_file = new_file
@@ -335,9 +341,10 @@ describe Boxr::Client do
     expect(result).to eq({})
   end
 
+  #rake spec SPEC_OPTS="-e \"invokes collaborations operations"\"
   it "invokes collaborations operations" do
     puts "add collaboration"
-    collaboration = BOX_CLIENT.add_collaboration(@test_folder, {id: @test_user.id, type: :user}, :editor)
+    collaboration = BOX_CLIENT.add_collaboration(@test_folder, {id: @test_user.id, type: :user}, :viewer_uploader)
     expect(collaboration.accessible_by.id).to eq(@test_user.id)
     COLLABORATION = collaboration
 
@@ -363,8 +370,12 @@ describe Boxr::Client do
     puts "inspect pending collaborations"
     pending_collaborations = BOX_CLIENT.pending_collaborations
     expect(pending_collaborations).to eq([])
+
+    puts "add invalid collaboration"
+    expect { BOX_CLIENT.add_collaboration(@test_folder, {id: @test_user.id, type: :user}, :invalid_role)}.to raise_error
   end
 
+  #rake spec SPEC_OPTS="-e \"invokes task operations"\"
   it "invokes task operations" do
     test_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder)
     collaboration = BOX_CLIENT.add_collaboration(@test_folder, {id: @test_user.id, type: :user}, :editor)
@@ -419,9 +430,9 @@ describe Boxr::Client do
     expect(result).to eq({})
   end
 
+  #rake spec SPEC_OPTS="-e \"invokes metadata operations"\"
   it "invokes metadata operations" do
     test_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder)
-    #test_file_id = new_file.id
 
     puts "create metadata"
     meta = {"a" => "hello", "b" => "world"}
@@ -441,6 +452,7 @@ describe Boxr::Client do
     expect(result).to eq({})
   end
 
+  #rake spec SPEC_OPTS="-e \"invokes search operations"\"
   it "invokes search operations" do
     #the issue with this test is that Box can take between 5-10 minutes to index any content uploaded; this is just a smoke test
     #so we are searching for something that should return zero results
@@ -449,8 +461,4 @@ describe Boxr::Client do
     expect(results).to eq([])
   end
 
-  it "invokes a Boxr error" do
-    expect { BOX_CLIENT.folder(1)}.to raise_error
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Chad Burnette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: ''
 email:
 - chadburnette@me.com