boxr 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4b56f62f19efeb0a8dceda9d6202e1ae48482e7
-  data.tar.gz: 90061fcec499a86417cac92dffb1c98f82a6ae1e
+  metadata.gz: 8e288ec193acb62b043385675eb9774600010f64
+  data.tar.gz: 04154af36d232ae6f5383708c3f759c99d86d8d4
 SHA512:
-  metadata.gz: fb9ae2f87f8f9179f4170bf9d8fa1c236d2eff8e4f92cd3775cd024d52eeb63491f045e9750bcc15b99519e3756f72cc52d1c6d1b0949cefea274658fb7789c6
-  data.tar.gz: 985e8aa0dcd6605732eeacf929b6b14d38ea3e157d63739c345c1d0fe406a1a64074b37ab5b5c06f2537af7ef4508fafd0561db9730bd19ae191448970e8bc67
+  metadata.gz: 089b8d6d04ac0258883b23522a781a6dc1f8e40f31436a64de711fd691f089b2245dffa6dcc6185dd8b3489d9c1d0c20fdc6d8c03a9223336a3adb054fa1eb9e
+  data.tar.gz: 858f7f86ada92d1d0ce9668355a226f58f216946790030fd9aa6299f7cb9deb8ea7bc5147e160bfb699001c1686f05c8d80bd8983258de83dac8fd6dffaa4a1f

data/README.md

@@ -73,10 +73,16 @@ client = Boxr::Client.new('zX3UjFwNerOy5PSWc2WI8aJgMHtAjs8T',
 # BOX_CLIENT_ID and BOX_CLIENT_SECRET, respectively.  You can omit the two optional parameters above
 # if those are present.
 
-# Additionally, you can provide one other parameter called identifier. This can be used, for example, to
+# You can provide another parameter called as_user. Read about what that means here: https://developers.box.com/docs/#users-as-user
+
+# You can provide yet another parameter called identifier. This can be used, for example, to
 # hold the id of the user associated with this Boxr client.  When the callback is invoked this value 
 # will be provided.
 ```
+Here's the complete method signature to initialize an instance of Boxr::Client
+```ruby
+initialize(access_token=ENV['BOX_DEVELOPER_TOKEN'], refresh_token: nil, box_client_id: ENV['BOX_CLIENT_ID'], box_client_secret: ENV['BOX_CLIENT_SECRET'], identifier: nil, as_user: nil, &token_refresh_listener)
+```
   
 ### A quick example
 Before diving into detailed documentation, let's take a look at how to accomplish a simple task with Boxr.  This script will find a specific folder given its path, upload a file to that folder, and create an open shared link to that file.

data/lib/boxr/client.rb

@@ -51,14 +51,16 @@ module Boxr
     GROUP_FIELDS_QUERY = GROUP_FIELDS.join(',')
     
 
-    def initialize(access_token, refresh_token: nil, box_client_id: ENV['BOX_CLIENT_ID'], box_client_secret: ENV['BOX_CLIENT_SECRET'], 
-                    identifier: nil, as_user_id: nil, &token_refresh_listener)
+    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'], 
+                    identifier: nil, as_user: nil, &token_refresh_listener)
       @access_token = access_token
+      raise BoxrException.new(boxr_message: "Access token cannot be nil") if @access_token.nil?
+
       @refresh_token = refresh_token
       @box_client_id = box_client_id
       @box_client_secret = box_client_secret
       @identifier = identifier
-      @as_user_id = as_user_id
+      @as_user_id = ensure_id(as_user)
       @token_refresh_listener = token_refresh_listener
     end
 

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/spec/boxr_spec.rb

@@ -15,7 +15,7 @@ describe Boxr::Client do
 
   #follow the directions in .env.example to set up your BOX_DEVELOPER_TOKEN
   #keep in mind it is only valid for 60 minutes
-  BOX_CLIENT = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'])
+  BOX_CLIENT = Boxr::Client.new #using ENV['BOX_DEVELOPER_TOKEN']
   
   #uncomment this line to see the HTTP request and response debug info in the rspec output
   #Boxr::turn_on_debugging

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Chad Burnette