box-api 0.1.6 → 0.1.7

data/.gitignore

@@ -1 +1,3 @@
 pkg/
+examples/app_data.yml
+spec/helper/account.yml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    box-api (0.1.6)
+    box-api (0.1.7)
       httmultiparty (~> 0.3)
 
 GEM

data/README.md

@@ -8,6 +8,12 @@ You can use the Box.net API to create applications and websites that integrate w
 * Move, rename and delete files
 * Share files
 
+### Install ###
+
+    gem install box-api
+
+That's it!
+
 ### Usage ###
 
 You must first obtain an API key by [registering your Box.net application](http://www.box.net/developers/services).

data/box-api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "box-api"
-  s.version     = "0.1.6"
+  s.version     = "0.1.7"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Box.net", "Luke Curley"]
   s.email       = ["luke@box.net"]

data/examples/app_data.yml

@@ -1,6 +1,3 @@
---- 
+---
 api_key: ezgx2366bod57zqvgk0lhjuy3l367arp
-auth_token: !str 
-  str: ouaq0t5r18psa5zcxqo339arfizcn9mr
-  :@attributes: {}
-
+auth_token: yrvp951t1055tpm1g1nxr2u09vx3trj2

data/lib/box/account.rb

@@ -54,7 +54,7 @@ module Box
 
     # the user must visit this url to allow the application to access their account
     def authorize_url(ticket = self.ticket)
-      "#{ api.url }/auth/#{ ticket }"
+      "#{ api.base_url }/auth/#{ ticket }"
     end
 
     # using the ticket, we get the auth_token providing the user has already allowed our application the privilege

data/lib/box/api.rb

@@ -6,6 +6,8 @@ module Box
   class Api
     include HTTMultiParty # a slight modification to HTTParty, adding multi-part upload support
 
+    attr_accessor :base_url, :upload_url
+
     def initialize(key, url = 'https://box.net', upload_url = 'https://upload.box.net', version = '1.0')
       @default_params = { :api_key => key } # add the api_key to every query
 

data/lib/box/folder.rb

@@ -7,6 +7,7 @@ module Box
 
     def self.type; 'folder'; end
 
+    # override the existing info method so that we create empty folders/files first
     def info(refresh = false)
       return self if @cached_info and not refresh
 
@@ -50,7 +51,7 @@ module Box
     # search for items using criteria
     def find(criteria)
       recursive = criteria.delete(:recursive)
-      recursive = true if recursive == nil # default to true
+      recursive = false if recursive == nil # default to false for performance reasons
 
       tree if recursive # get the full tree
 
@@ -103,6 +104,7 @@ module Box
       end
     end
 
+    # update the cached status of all sub items, as we got the entire tree
     def force_cached_tree
       create_sub_items(nil, Box::Folder)
       create_sub_items(nil, Box::File)
@@ -119,6 +121,7 @@ module Box
       end
     end
 
+    # search for any files/folders that match the criteria sent
     def find!(criteria, recursive)
       matches = (files + folders).collect do |item| # search over our files and folders
         match = criteria.all? do |key, value| # make sure all criteria pass

data/lib/box/item.rb

@@ -11,6 +11,7 @@ module Box
       update_info(info) # merges with the info hash, and renames some fields
     end
 
+    # return the string representation of this item (file or folder)
     def self.type; raise "Overwrite this method"; end
     def self.types; type + 's'; end
 
@@ -29,6 +30,7 @@ module Box
 
       self
     end
+
     # move the item to the destination folder
     def move(destination)
       @api.move(type, id, destination.id)
@@ -69,6 +71,7 @@ module Box
       self
     end
 
+    # set the description of the item
     def description(message)
       @api.set_description(type, id, message)
 
@@ -102,10 +105,11 @@ module Box
     # sub-classes are meant to implement this
     def get_info(*args); Hash.new; end
 
+    # takes in a hash of info, cleans it, and merges it into the existing info
     def update_info(info)
       ninfo = Hash.new
 
-      # the api is stupid and some fields are named 'file_id' or 'id' inconsistently, so trim the type off
+      # some fields are named 'file_id' or 'id' inconsistently, so trim the type off
       info.each do |name, value|
         if name.to_s =~ /^#{ type }_(.+)$/; ninfo[$1] = value
         else; ninfo[name.to_s] = value; end
@@ -114,11 +118,13 @@ module Box
       @data.merge!(ninfo) # merge in the updated info
     end
 
+    # delete the cache for a specific info
     def delete_info(field)
       @cached_info = false
       @data.delete(field)
     end
 
+    # delete the entire cache
     def clear_info
       @cached_info = false
       @data.clear

data/spec/file_spec.rb

@@ -9,7 +9,7 @@ describe Box::File do
   describe "operations" do
     before(:all) do
       @root = get_root
-      spec = @root.find(:name => 'rspec folder', :type => 'folder', :recursive => false).first
+      spec = @root.find(:name => 'rspec folder', :type => 'folder').first
       spec.delete if spec
     end
 

data/spec/folder_spec.rb

@@ -9,7 +9,7 @@ describe Box::Folder do
   context "with api" do
     before(:all) do
       @root = get_root
-      spec = @root.find(:name => 'rspec folder', :type => 'folder', :recursive => false).first
+      spec = @root.find(:name => 'rspec folder', :type => 'folder').first
       spec.delete if spec
     end
 
@@ -58,27 +58,27 @@ describe Box::Folder do
     describe "#find" do
       describe "single result" do
         it "finds existing item" do
-          file = @root.find(:name => 'expected.1.swf').first
+          file = @root.find(:name => 'expected.1.swf', :recursive => true).first
           file.id.should == '61679540'
           file.name.should == 'expected.1.swf'
         end
 
         it "finds non-existant file" do
-          file = @root.find(:name => 'notfound.png').first
+          file = @root.find(:name => 'notfound.png', :recursive => true).first
           file.should be nil
         end
 
         it "finds specified format" do
-          folder = @root.find(:name => 'tests', :type => 'folder').first
+          folder = @root.find(:name => 'tests', :type => 'folder', :recursive => true).first
           folder.id.should == '7065552'
           folder.name.should == 'tests'
 
-          file = @root.find(:name => 'tests', :type => 'file').first
+          file = @root.find(:name => 'tests', :type => 'file', :recursive => true).first
           file.should be nil
         end
 
         it "finds specified criteria" do
-          file = @root.find(:type => 'file', :sha1 => 'f7379ffe883fdc355fbe47e8a4b3073f21ac0f6d').first
+          file = @root.find(:type => 'file', :sha1 => 'f7379ffe883fdc355fbe47e8a4b3073f21ac0f6d', :recursive => true).first
           file.id.should == '61669270'
           file.name.should == 'file.pdf'
         end
@@ -89,25 +89,25 @@ describe Box::Folder do
         end
 
         it "finds multiple criteria" do
-          file = @root.find(:updated => 1304959908, :size => 20372).first
+          file = @root.find(:updated => 1304959908, :size => 20372, :recursive => true).first
           file.id.should == '61679546'
           file.name.should == 'expected.3.swf'
         end
 
         it "requires both criteria" do
-          file = @root.find(:updated => 1304, :size => 20372).first
+          file = @root.find(:updated => 1304, :size => 20372, :recursive => true).first
           file.should be nil
         end
       end
 
       describe "multiple results" do
         it "finds multiple files" do
-          items = @root.find(:name => 'expected.1.swf')
+          items = @root.find(:name => 'expected.1.swf', :recursive => true)
           items.should have(2).items
         end
 
         it "finds all files" do
-          files = @root.find(:type => 'file')
+          files = @root.find(:type => 'file', :recursive => true)
           files.should have(9).items
           files.first.name.should == 'file.pdf'
         end

data/spec/helper/account.yml

@@ -1,3 +1,3 @@
 ---
 api_key: ezgx2366bod57zqvgk0lhjuy3l367arp
-auth_token: ouaq0t5r18psa5zcxqo339arfizcn9mr
+auth_token: yrvp951t1055tpm1g1nxr2u09vx3trj2

metadata

@@ -2,7 +2,7 @@
 name: box-api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Box.net
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-28 00:00:00 -04:00
+date: 2011-07-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -108,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2193464046297207864
+      hash: -2887608171974797695
       segments: 
       - 0
       version: "0"
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2193464046297207864
+      hash: -2887608171974797695
       segments: 
       - 0
       version: "0"