ruby-box 1.2.1 → 1.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Njk0MDYwM2Y2MjVmZDIwZjg3ZGZmZjE3ODEyM2FlNGY0NGI0ZmI4MQ==
+    MmFhODFkOWNiMGFhOTkwN2QwNmFlYTY5Y2I2OTk4NGU1NDcwZmM5Mw==
   data.tar.gz: !binary |-
-    MmM3NGM4OTBkMzBiYjk2MWZkMGMwOTExNWIyODkwMGM1NjFmOWM4MQ==
+    Y2Y1NzM1MjQzZDk5ZDJlZTBhZGRiMWEyMmNiMDBmZTA3YmZkNzhlYw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MTE1YjFhYTRkYWFlMTk4YWZkNjkxZDY2ZmU3MWFkNjRmMDk3NTA2MTI1OWE2
-    MGNjMDljNWYyYTZlOTM2NmFlOGU3NDA5YTgzOWVmMGJmODMzZmQwNzMwZTNm
-    MWRjMzY1OWJhZTE2MTY4ZjRiYTY4NmI4OWFkMzJlMTgzN2YzMDU=
+    OGQxZWNkNzhmMDQ0ZGUzYWEwM2JkMzE5Y2ZiNWFiMWI3MTkyZTk3ZGVkODM5
+    Nzk4ZDNlMWI5N2M3ODY3ODE0YzViZWViMDFmOWViN2NhNzdhMGUyZjA4MTBl
+    ZWIzY2MzNDgwMTJkNmMwOTJjZTY1ZjBkYzU0OTg1MzNjZGVjMjA=
   data.tar.gz: !binary |-
-    NzAwOTc5YWEzMTlmNGY3NjcyNDU0NjZjM2JlNGU3ZDlhNjMyMGNhOTY2ODUz
-    YWM2NzFhNzY3MTAxZDY2N2IzZTU0MzVlZWE2NjQ5NDBhNTM3NGY2NTA3NTE5
-    M2JhNjEzZWQ2YjBjMzBjNGJjNzAyNTYzNDY4ZTI5YjhjMmY0N2M=
+    MzE4MDEwOWIzZjBiMzhjMjU3NjI5OWNlZjljZGY0N2M5ZDA2Y2I1MDQyODhh
+    NGUwOTQyYmI4MGM3ZWRkM2RjNzFhMzhiYzljMmRhZGMwMmNmZGRhYzBiN2Ez
+    MzdmZWRmOWQ2NTFjMTZhZGE0NWJkOWJiODA5ZTViNTYwY2YxYzQ=

data/README.markdown

@@ -1,12 +1,12 @@
 ruby-box
---------
+========
 
 Mainted by: [Attachments.me](https://attachments.me)
 
 RubyBox provides a simple, chainable, feature-rich client for [Box's 2.0 API](http://developers.box.com/docs/).
 
 Authorization
-=============
+-------------
 
 RubyBox uses Box's OAuth2 Implementaton, Here are the steps involved in authorizing a client:
 
@@ -49,12 +49,12 @@ client = RubyBox::Client.new(session)
 ```
 
 Usage
------
+=====
 
 Once you've created a client, you can start interacting with the Box API. What follows are some basic examples of RubyBox's usage:
 
 Folders
-=======
+-------
 
 * Listing items in a folder:
 
@@ -87,7 +87,7 @@ discussion.comments.each {|comment| p comment.message}
 ```
 
 Files
-=====
+-----
 
 * Fetching a file's meta information.
 
@@ -127,7 +127,7 @@ end
 ```
 
 Search
-======
+------
 
 You can use RubyBox's search method to return files and folders that match a given query.
 
@@ -139,7 +139,7 @@ end
 ```
 
 Events
-======
+------
 
 You can use RubyBox's event_response method to return an EventResponse that can be used to process any incoming events.
 
@@ -155,7 +155,7 @@ end
 
 
 Contributors
-------------
+============
 
 * Benjamin Coe
 * Larry Kang
@@ -163,7 +163,7 @@ Contributors
 * Jesse Miller
 
 Contributing to ruby-box
------------------------
+========================
 
 RubyBox does not yet support all of Box's API Version 2.0 functionality, be liberal with your contributions.
  
@@ -175,7 +175,7 @@ RubyBox does not yet support all of Box's API Version 2.0 functionality, be libe
 * Submit a pull request
 
 Copyright
----------
+=========
 
 Copyright (c) 2012 Attachments.me. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.3.0

data/lib/ruby-box/folder.rb

@@ -4,22 +4,16 @@ module RubyBox
     has_many :discussions
     has_many_paginated :items
 
-    def files(name=nil, item_limit=100, offset=0)
-      items(item_limit, offset).select do |item|
-        item.kind_of? RubyBox::File and (name.nil? or item.name == name)
-      end
+    def files(name=nil, item_limit=100, offset=0, fields=nil)
+      items_by_type(RubyBox::File, name, item_limit, offset, fields)
     end
 
-    def folders(name=nil, item_limit=100, offset=0)
-      items(item_limit, offset).select do |item|
-        item.kind_of? RubyBox::Folder and (name.nil? or item.name == name)
-      end
+    def folders(name=nil, item_limit=100, offset=0, fields=nil)
+      items_by_type(RubyBox::Folder, name, item_limit, offset, fields)
     end
 
-    def collaborations(item_limit=100, offset=0)
-      items(item_limit, offset).select do |item|
-        item.kind_of? RubyBox::Collaboration
-      end
+    def collaborations(item_limit=100, offset=0, fields=nil)
+      items_by_type(RubyBox::Collaboration, nil, item_limit, offset, fields)
     end
 
     def upload_file(filename, data)
@@ -57,5 +51,19 @@ module RubyBox
     def update_fields
       ['name', 'description']
     end
+
+    def items_by_type(type, name, item_limit, offset, fields)
+
+      # allow paramters to be set via
+      # a hash rather than a list of arguments.
+      if name.is_a?(Hash)
+        return items_by_type(type, name[:name], name[:item_limit], name[:offset], name[:fields])
+      end
+
+      items(item_limit, offset, fields).select do |item|
+        item.kind_of? type and (name.nil? or item.name == name)
+      end
+
+    end
   end
 end

data/lib/ruby-box/item.rb

@@ -51,7 +51,7 @@ module RubyBox
 
       # 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) if @@has_many_paginated.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?('=')
@@ -93,10 +93,11 @@ module RubyBox
       resp['entries'].map {|i| RubyBox::Item.factory(@session, i)}
     end
 
-    def paginated(key, item_limit=100, offset=0)
+    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))

data/ruby-box.gemspec

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

data/spec/folder_spec.rb

@@ -54,6 +54,18 @@ describe RubyBox::Folder do
       items[0].kind_of?(RubyBox::Folder).should == true
       items[1].kind_of?(RubyBox::File).should == true
     end
+
+    it "should allow a fields parameter to be set" do
+      RubyBox::Session.any_instance.should_receive(:get).with('https://api.box.com/2.0/folders/1/items?limit=100&offset=0&fields=size').and_return({'entries' => []})
+      session = RubyBox::Session.new
+      RubyBox::Folder.new(session, {'id' => 1}).items(100, 0, [:size]).to_a
+    end
+
+    it "should not have the fields parameter set by default" do
+      RubyBox::Session.any_instance.should_receive(:get).with('https://api.box.com/2.0/folders/1/items?limit=100&offset=0').and_return({'entries' => []})
+      session = RubyBox::Session.new
+      RubyBox::Folder.new(session, {'id' => 1}).items.to_a
+    end
   end
 
   describe '#files' do

data/spec/integration_spec.rb

@@ -80,6 +80,16 @@ describe RubyBox, :skip => true do
         file.id.should == "2550686921"
       end      
     end
+
+    describe '#files' do
+      it "allows additional fields to be requested in file listing" do
+        folder = RubyBox::Folder.new(@session, {'id' => '318810303'})
+        file = folder.files({fields: [:name, :size]}).first
+        file.id.should == "2550686921"
+        file.name.should == "2513582219_03fb9b67db_b.jpg"
+        file.size.should == 593978
+      end
+    end
     
     describe '#create' do
       it "creates a folder" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-box
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Attachments.me
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -174,4 +174,3 @@ signing_key:
 specification_version: 4
 summary: ruby gem for box.com 2.0 api
 test_files: []
-has_rdoc: