boxr 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f91a21daf6cd40a57ba2b240f980ecdd9b0bc53
-  data.tar.gz: 5a44c1b4e0750902636de3d96444863be26f6f4e
+  metadata.gz: 80bb5e98b518eb34aaaddc369a739111cb2bbcd1
+  data.tar.gz: 852abc3f680cf0e7e379c67e1fad79096c871d3a
 SHA512:
-  metadata.gz: 19377c61c9d9f3b36d7319d0048c291629af9b03099820b8ec732236fd24856186ce540c65a47c24830cc2ecffba313738f017e2b1e8b0a8ccda7d699e226b6d
-  data.tar.gz: cbbe61b6758e677b23494b971f7cdf7e84f48dee81dd4c8bf6aba1258157ba0b4056b35365b3a787b24a37eadc0f7ffc7e601007570bca321498bcc27e320696
+  metadata.gz: eb43cff1678d67aaa57366a99bed71eed95babcaa3d608404c3362385d26e30e3d69d5a528f11e1ec752b1a3f83ce168c3da4c984f8bdbc65f9e44064540de61
+  data.tar.gz: 24926c43ccc5d4992168b231c97f68780732e5d502be9590f359107edf7c6cadf37171f76b4b9153397c42f8cfa1a6de026abd16067f6e90c1ae23ac8f5bcc15

data/README.md

@@ -97,22 +97,28 @@ client = Boxr::Client.new  #using ENV['BOX_DEVELOPER_TOKEN']
 
 folder = client.folder_from_path('/some/directory/structure')
 file = client.upload_file('test.txt', folder)
-file = client.create_shared_link_for_file(file, access: :open)
-puts "Shared Link: #{file.shared_link.url}"
+updated_file = client.create_shared_link_for_file(file, access: :open)
+puts "Shared Link: #{updated_file.shared_link.url}"
 ```
 
 ### Methods
-#### [OAuth](https://developers.box.com/docs/#oauth-2)
+#### [OAuth & JWT](https://developers.box.com/docs/#oauth-2)
 ```ruby
 #NOTE: these are all module methods
 
-Boxr::oauth_url(state, host: "app.box.com", response_type: "code", scope: nil, folder_id: nil, box_client_id: ENV['BOX_CLIENT_ID'])
+#OAuth methods
+Boxr::oauth_url(state, host: "app.box.com", response_type: "code", scope: nil, folder_id: nil, 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'])
+Boxr::get_tokens(code=nil, grant_type: "authorization_code", assertion: nil, scope: nil, username: nil, client_id: ENV['BOX_CLIENT_ID'], client_secret: ENV['BOX_CLIENT_SECRET'])
 
-Boxr::refresh_tokens(refresh_token, box_client_id: ENV['BOX_CLIENT_ID'], box_client_secret: ENV['BOX_CLIENT_SECRET'])
+Boxr::refresh_tokens(refresh_token, client_id: ENV['BOX_CLIENT_ID'], client_secret: ENV['BOX_CLIENT_SECRET'])
 
-Boxr::revoke_tokens(token, box_client_id: ENV['BOX_CLIENT_ID'], box_client_secret: ENV['BOX_CLIENT_SECRET'])
+Boxr::revoke_tokens(token, client_id: ENV['BOX_CLIENT_ID'], client_secret: ENV['BOX_CLIENT_SECRET'])
+
+#JWT methods
+Boxr::get_enterprise_token(private_key: ENV['JWT_PRIVATE_KEY'], private_key_password: ENV['JWT_PRIVATE_KEY_PASSWORD'], enterprise_id: ENV['BOX_ENTERPRISE_ID'], client_id: ENV['BOX_CLIENT_ID'])
+
+Boxr::get_user_token(user_id, private_key: ENV['JWT_PRIVATE_KEY'], private_key_password: ENV['JWT_PRIVATE_KEY_PASSWORD'], client_id: ENV['BOX_CLIENT_ID'])
 ```
 #### [Folders](https://developers.box.com/docs/#folders)
 ```ruby

data/lib/boxr/auth.rb

@@ -24,12 +24,16 @@ module Boxr
     auth_post(uri, body)
   end
 
-  def self.get_enterprise_token(private_key, scope: nil, enterprise_id: ENV['BOX_ENTERPRISE_ID'], client_id: ENV['BOX_CLIENT_ID'])
-    jwt_auth_post(private_key, scope, client_id, enterprise_id, "enterprise")
+  def self.get_enterprise_token(private_key: ENV['JWT_PRIVATE_KEY'], private_key_password: ENV['JWT_PRIVATE_KEY_PASSWORD'],
+                                enterprise_id: ENV['BOX_ENTERPRISE_ID'], client_id: ENV['BOX_CLIENT_ID'])
+    unlocked_private_key = unlock_key(private_key, private_key_password)
+    jwt_auth_post(unlocked_private_key, client_id, enterprise_id, "enterprise")
   end
 
-  def self.get_user_token(private_key, user_id, scope: nil, client_id: ENV['BOX_CLIENT_ID'])
-    jwt_auth_post(private_key, scope, client_id, user_id, "user")
+  def self.get_user_token(user_id, private_key: ENV['JWT_PRIVATE_KEY'], private_key_password: ENV['JWT_PRIVATE_KEY_PASSWORD'],
+                          client_id: ENV['BOX_CLIENT_ID'])
+    unlocked_private_key = unlock_key(private_key, private_key_password)
+    jwt_auth_post(unlocked_private_key, client_id, user_id, "user")
   end
 
   def self.refresh_tokens(refresh_token, client_id: ENV['BOX_CLIENT_ID'], client_secret: ENV['BOX_CLIENT_SECRET'])
@@ -54,7 +58,8 @@ module Boxr
 
   private
 
-  def self.jwt_auth_post(private_key, scope, iss, sub, box_sub_type)
+
+  def self.jwt_auth_post(private_key, iss, sub, box_sub_type)
     payload = {
       iss: iss,
       sub: sub,
@@ -65,7 +70,7 @@ module Boxr
     }
     assertion = JWT.encode(payload, private_key, "RS256")
 
-    get_token(grant_type: JWT_GRANT_TYPE, assertion: assertion, scope: scope)
+    get_token(grant_type: JWT_GRANT_TYPE, assertion: assertion)
   end
 
   def self.auth_post(uri, body)
@@ -81,4 +86,12 @@ module Boxr
     end
   end
 
+  def self.unlock_key(private_key, private_key_password)
+    if private_key.is_a?(OpenSSL::PKey::RSA)
+      private_key
+    else
+      OpenSSL::PKey::RSA.new(private_key, private_key_password)
+    end
+  end
+
 end

data/lib/boxr/client.rb

@@ -53,14 +53,26 @@ module Boxr
     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, client_id: ENV['BOX_CLIENT_ID'], client_secret: ENV['BOX_CLIENT_SECRET'], 
-                    identifier: nil, as_user: nil, &token_refresh_listener)
+    def initialize( access_token=ENV['BOX_DEVELOPER_TOKEN'], 
+                    refresh_token: nil, 
+                    client_id: ENV['BOX_CLIENT_ID'], 
+                    client_secret: ENV['BOX_CLIENT_SECRET'],
+                    enterprise_id: ENV['BOX_ENTERPRISE_ID'],
+                    jwt_private_key: ENV['JWT_PRIVATE_KEY'], 
+                    jwt_private_key_password: ENV['JWT_PRIVATE_KEY_PASSWORD'],
+                    identifier: nil, 
+                    as_user: nil, 
+                    &token_refresh_listener)
+
       @access_token = access_token
       raise BoxrError.new(boxr_message: "Access token cannot be nil") if @access_token.nil?
 
       @refresh_token = refresh_token
       @client_id = client_id
       @client_secret = client_secret
+      @enterprise_id = enterprise_id
+      @jwt_private_key = jwt_private_key
+      @jwt_private_key_password = jwt_private_key_password
       @identifier = identifier
       @as_user_id = ensure_id(as_user)
       @token_refresh_listener = token_refresh_listener
@@ -179,21 +191,34 @@ module Boxr
 
     def standard_headers()
       headers = {"Authorization" => "Bearer #{@access_token}"}
-      headers['As-User'] = "#{@as_user_id}" unless @as_user_id.nil?
+      if @jwt_private_key.nil?
+        headers['As-User'] = "#{@as_user_id}" unless @as_user_id.nil?
+      end
       headers
     end
 
     def with_auto_token_refresh
-      return yield unless @refresh_token
+      return yield unless @refresh_token or @jwt_secret_key
 
       res = yield
       if res.status == 401
         auth_header = res.header['WWW-Authenticate'][0]
         if auth_header && auth_header.include?('invalid_token')
-          new_tokens = Boxr::refresh_tokens(@refresh_token, client_id: client_id, client_secret: client_secret)
-          @access_token = new_tokens.access_token
-          @refresh_token = new_tokens.refresh_token
-          @token_refresh_listener.call(@access_token, @refresh_token, @identifier) if @token_refresh_listener
+          if @refresh_token
+            new_tokens = Boxr::refresh_tokens(@refresh_token, client_id: client_id, client_secret: client_secret)
+            @access_token = new_tokens.access_token
+            @refresh_token = new_tokens.refresh_token
+            @token_refresh_listener.call(@access_token, @refresh_token, @identifier) if @token_refresh_listener
+          else
+            if @as_user_id
+              new_token = Boxr::get_user_token(@as_user_id, private_key: @jwt_private_key, private_key_password: @jwt_private_key_password, client_id: @client_id)
+              @access_token = new_token.access_token
+            else
+              new_token = Boxr::get_enterprise_token(private_key: @jwt_private_key, private_key_password: @jwt_private_key_password, enterprise_id: @enterprise_id, client_id: @client_id)
+              @access_token = new_token.access_token
+            end
+          end
+
           res = yield
         end
       end

data/lib/boxr/events.rb

@@ -12,7 +12,7 @@ module Boxr
       events = []
       loop do
         event_response = get_enterprise_events(created_after, created_before, stream_position, event_type, limit)
-        event_response.events.each{|event| events << event}
+        events.concat(event_response.events)
         stream_position = event_response.next_stream_position
 
         break if event_response.events.empty?

data/lib/boxr/metadata.rb

@@ -18,6 +18,10 @@ module Boxr
     def update_metadata(file, updates, scope: :global, template: :properties)
       file_id = ensure_id(file)
       uri = "#{METADATA_URI}/#{file_id}/metadata/#{scope}/#{template}"
+
+      #in the event just one update is specified ensure that it is packaged inside an array
+      updates = [updates] unless updates.is_a? Array
+
       metadata, response = put(uri, updates, content_type: "application/json-patch+json")
       metadata
     end

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "0.25.0"
+  VERSION = "0.26.0"
 end

data/spec/boxr_spec.rb

@@ -169,7 +169,7 @@ describe Boxr::Client do
 
     puts "download file"
     file = BOX_CLIENT.download_file(test_file)
-    f = open("./spec/test_files/#{DOWNLOADED_TEST_FILE_NAME}", 'w+')
+    f = File.open("./spec/test_files/#{DOWNLOADED_TEST_FILE_NAME}", 'w+')
     f.write(file)
     f.close
     expect(FileUtils.identical?("./spec/test_files/#{TEST_FILE_NAME}","./spec/test_files/#{DOWNLOADED_TEST_FILE_NAME}")).to eq(true)
@@ -469,8 +469,10 @@ describe Boxr::Client do
     expect(metadata.a).to eq("hello")
 
     puts "update metadata"
-    metadata = BOX_CLIENT.update_metadata(test_file, [{op: :replace, path: "/b", value: "there"}])
+    metadata = BOX_CLIENT.update_metadata(test_file, {op: :replace, path: "/b", value: "there"})
     expect(metadata.b).to eq("there")
+    metadata = BOX_CLIENT.update_metadata(test_file, [{op: :replace, path: "/b", value: "friend"}])
+    expect(metadata.b).to eq("friend")
 
     puts "get metadata"
     metadata = BOX_CLIENT.metadata(test_file)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Chad Burnette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler