ruby-box 1.4.0 → 1.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODI2ZDdkYWJmMDQ3ZGZiMDQ1ZGI3NDljOTM0ZGY2ZDhiMGM1YWE2Mw==
+    Nzk0MzA1ZmJjZTkyODM4ZjQ0YjcxNTM5ZWQ0MTIyYjFjYTRkN2UxMw==
   data.tar.gz: !binary |-
-    ODNjY2YyZTA5ODcwMjU3ZjNmODljYjY1MzM5YTcxODYwZjgzNTcyMA==
+    MTE2NjQ3MTZmN2M2NGM4ZGU0ZWY1YWVjZTBjMzljZDdhZWFhZWE3MQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDYxYmQ5ZjAyZjYyNzc4MzczNjEwZTdjMWNhOGI4ZWFkODI0OWJjMzVjNGJk
-    ODYyMTQ2ZmVlMmUwZDNkMDE5NGY2NTZjOTgyYWQ5MGMzOGFhYTEzMjhhN2Qy
-    ZDVlY2JkM2E0N2U2NTEzYzA2ZDJkYTZjYjJkODUwYTRjZjI5YmE=
+    YTAxYTFiMjI2YjNiNDU3ZGIwMjQzNjkzMDI5MjRkMWMxZmE0MDgyOTBhY2Qz
+    ZDgwODQ1Njc2ZGNlNzM1YzcyNWI3ZDExMTVjZmFmMTdlZmI4YTZmZmE0NmJh
+    MmEyMGQ3ZmZlYjhkZGYyYjJmNDZhNzZjYzJkZDE2MDVhNjk1OWE=
   data.tar.gz: !binary |-
-    OTliM2MyMjk3ZmJmNzIxY2I3MjBmYWJjM2IzNWEwNThmN2I0Nzc2NjcxMmQ1
-    MDNhNzFmNjk1YjdlMDIzZjkyYTA0ZGNlYTY1MWFiOThmZDAzYzlkM2IxZWQw
-    OTg5NmRmMTRkNzBkNzMxNjhiMWU4MzEwMzE4ZTMzMGQ5OGU1YTc=
+    M2Y3OTAxMjQ5Zjc1NmJjM2Y1MDkyNTQyNmVmMzkwZjQyNzU5YWJkMDdlYjRl
+    NmU3ZGMwMDAyOTBkOTAyN2U4NzhhN2EyZGJlNTkyNTI5OGFmOTQ0MzViYWMw
+    Yjg2M2RjNzdlYTYyOGFhNGJjYTc5MGU0M2JlN2Y2OTc1YTU0NGQ=

data/README.markdown

@@ -31,7 +31,14 @@ p '@token.token' # the access token.
 p '@token.refresh_token' # token that can be exchanged for a new access_token once the access_token expires.
 
 # refreshing token.
-@token = session.refresh_token('refresh-token-string')
+
+session = RubyBox::Session.new({
+  client_id: 'your-client-id',
+  client_secret: 'your-client-secret',
+  access_token: 'original-access-token' 
+})
+
+@token = session.refresh_token('your-refresh-token')
 ```
 
 __3)__ Create a client using a session initialized with the _access\_token_.
@@ -86,6 +93,13 @@ discussion = folder.discussions.first
 discussion.comments.each {|comment| p comment.message}
 ```
 
+* Creating a shared link for a folder.
+
+```ruby
+folder = client.folder('image_folder').create_shared_link
+p folder.shared_link['url'] # https://www.box.com/s/d6de3224958c1755412
+```
+
 Files
 -----
 
@@ -126,6 +140,13 @@ comments.each do |comment|
 end
 ```
 
+* Creating a shared link for a file.
+
+```ruby
+file = client.file('/image_folder/an-image.jpg').create_shared_link
+p file.shared_link['url'] # https://www.box.com/s/d6de3224958c1755412
+```
+
 Search
 ------
 
@@ -152,8 +173,6 @@ eresp.events.each do |ev|
 end
 ```
 
-
-
 Contributors
 ============
 

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.5.0

data/lib/ruby-box/exceptions.rb

@@ -14,4 +14,5 @@ module RubyBox
   class RequestError < RubyBoxError; end
   class ServerError < StandardError; end
   class ItemNameInUse < RubyBoxError; end
+  class UnshareableResource < StandardError; end
 end

data/lib/ruby-box/folder.rb

@@ -51,6 +51,15 @@ module RubyBox
       collaboration.create
     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
+    
     private
 
     def resource_name

data/lib/ruby-box/item.rb

@@ -82,6 +82,34 @@ module RubyBox
       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
+
     protected
 
     def self.factory(session, entry)

data/ruby-box.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ruby-box"
-  s.version = "1.4.0"
+  s.version = "1.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Attachments.me"]
-  s.date = "2013-06-21"
+  s.date = "2013-07-01"
   s.description = "ruby gem for box.com 2.0 api"
   s.email = "ben@attachments.me"
   s.extra_rdoc_files = [

data/spec/integration_spec.rb

@@ -198,5 +198,34 @@ describe RubyBox, :skip => true do
         folder.delete if folder
       end
     end
+
+    describe '#shared_link' do
+      it 'should allow a share link to be created for a folder' do
+        folder = @client.create_folder('/ruby-box_gem_testing/shared_folder').create_shared_link
+
+        # share link was successfully created.
+        folder.shared_link['url'].should match /https?:\/\/[\S]+/
+        
+        # share link can be disabled.
+        folder.disable_shared_link
+        folder.shared_link.should == nil
+
+        folder.delete if folder
+      end
+
+      it 'should allow a share link to be created for a file' do
+        utf8_file_name = '遠志教授.jpg'
+        file = @client.upload_file('spec/fixtures/' + utf8_file_name, '/ruby-box_gem_testing/cool stuff/').create_shared_link
+
+        # share link was successfully created.
+        file.shared_link['url'].should match /https?:\/\/[\S]+/
+        
+        # share link can be disabled.
+        file.disable_shared_link
+        file.shared_link.should == nil
+
+        file.delete        
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-box
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Attachments.me
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post