box-api 0.1.6

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in box-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    box-api (0.1.6)
+      httmultiparty (~> 0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    configuration (1.3.1)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    httmultiparty (0.3)
+      httparty (>= 0.7.3)
+      multipart-post
+    httparty (0.7.8)
+      crack (= 0.1.8)
+    launchy (0.4.0)
+      configuration (>= 0.0.5)
+      rake (>= 0.8.1)
+    multipart-post (1.1.2)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  box-api!
+  launchy
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,23 @@
+Box Ruby Library
+----------------
+
+You can use the Box.net API to create applications and websites that integrate with Box.net and can perform the following functions:
+
+* Store and retrieve files from Box.net
+* Organize files into folders
+* Move, rename and delete files
+* Share files
+
+### Usage ###
+
+You must first obtain an API key by [registering your Box.net application](http://www.box.net/developers/services).
+
+Once you have an API key, you are free to start using the box API! Check out the 'examples' folder for sample code and instructions.
+
+### Documentation ###
+
+You can find API documentation at [http://developers.box.net/](http://developers.box.net/). Full documentation regarding the Ruby library methods is coming soon.
+
+### Support ###
+
+If you have any questions or suggestions for improvement, ping us on our [forum](http://forum.developers.box.net/box_developers) or email us directly at developers[at]box[dot]net.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+

data/box-api.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = "box-api"
+  s.version     = "0.1.6"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Box.net", "Luke Curley"]
+  s.email       = ["luke@box.net"]
+  s.homepage    = "http://box.net"
+  s.summary     = %q{A ruby library that helps navigate the Box API}
+  s.description = %q{Box-api is a collection of classes that implement functions defined in the Box public API. See http://developer.box.net for more information.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = [ "lib", "spec" ]
+
+  s.add_dependency("httmultiparty", "~> 0.3")
+
+  s.add_development_dependency("launchy") # only used in examples
+  s.add_development_dependency("rake")
+  s.add_development_dependency("rspec")
+end

data/examples/app_data.yml

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

data/examples/files.rb

@@ -0,0 +1,36 @@
+# log in using the login example, so we don't have to duplicate code
+$: << File.dirname(__FILE__) # for 1.9
+require 'login'
+
+# get the root of the folder structure
+root = @account.root
+
+# list all of the folders in the root directory with their index
+root.folders.each_with_index do |folder, i|
+  puts "##{ i } -- #{ folder.name }"
+end
+
+# let the user pick one to show the contents of
+puts "Pick a folder number above to show: "
+index = gets
+
+begin
+  # grab the folder they selected
+  # to_i or [] will throw an exception if the index is invalid or out of range respectively
+  folder = root.folders[index.to_i]
+rescue
+  # they picked an invalid folder!
+  puts "You picked an invalid folder, please try again."
+  exit
+end
+
+# the folder they picked was valid
+puts "Excellent choice, here are the contents of that folder"
+
+# show the selected folder
+puts "FOLDER: #{ folder.name } (#{ folder.id })"
+
+# loop through and show each of the sub files and folders
+(folder.files + folder.folders).each do |item|
+  puts "\t#{ item.type.upcase }: #{ item.name } (#{ item.id })"
+end

data/examples/login.rb

@@ -0,0 +1,57 @@
+# add the lib directory to our require path (you do not need this if you install the box-api gem)
+$: << File.dirname(__FILE__) + "/../lib"
+
+# we use bundler to keep all of our gems up to date, but it is optional
+require 'rubygems'
+require 'bundler/setup'
+
+# we're only using account specific features in this example, so we don't need to require the entire gem
+require 'box/account'
+
+# launchy is a simple gem that opens a browser, but is completely optional
+require 'launchy'
+
+# we save all of our app data to a file, so we don't have to hard-code values
+app_data_file = File.dirname(__FILE__) + '/app_data.yml'
+app_data = YAML.load_file(app_data_file)
+
+# create an account object using the API key stored in app_data.yml
+# you need to get your own API key at http://www.box.net/developers/services
+account = Box::Account.new(app_data['api_key'])
+
+# the user has to authorize your app on the box website, at which point you'll get an auth token
+# this auth token works between sessions, so read it from disk if the user has authed before
+auth_token = app_data['auth_token']
+
+# now we have enough information to log into the box api, so we try to authorize using the auth token
+authed = account.authorize(auth_token) do |auth_url|
+  # this block is called if the auth_token is invalid or missing
+
+  # we use launchy to open a new browser, but you can do it however you want
+  Launchy.open(auth_url)
+
+  # make sure you pause until the user has authorized, or just tell them to restart the program
+  puts "Hit any key once you have logged in on the opened web page."
+  gets
+end
+
+unless authed
+  # the user didn't auth like we told them to, so we can't access anything
+  puts "Unable to login, please try again."
+  exit
+end
+
+# this auth token will let us instantly authorize next time this app is run, so we want to save it
+# keep in mind that an auth token only works with the same api key, and will expire if the user logs out
+app_data['auth_token'] = account.auth_token
+
+# we write the auth_token to file so it can be accessed on next run
+File.open(app_data_file, 'w') do |file|
+  YAML.dump(app_data, file)
+end
+
+# we managed to log in successfully!
+puts "Logged in as #{ account.info['login'] }"
+
+# this is so the other example can access the account variable (bad practice)
+@account = account

data/lib/box-api.rb

@@ -0,0 +1,16 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# These three are the only classes that should be accessed directly
+require 'box/account'
+require 'box/file'
+require 'box/folder'

data/lib/box/account.rb

@@ -0,0 +1,108 @@
+require 'box/api'
+require 'box/folder'
+
+module Box
+  class Account
+    attr_reader :api, :ticket, :auth_token
+
+    # setup the api using our api_key
+    def initialize(api)
+      @api = case
+        when api.class == Box::Api; api # use the api object as passed in
+        else; Box::Api.new(api) # allows user to pass in the api_key rather than make a new API object themselves
+      end
+    end
+
+    #### AUTHENTICATION SECTION ####
+    # register the user with the given details
+    def register(email, password)
+      # note: this function can throw EmailInvalid and EmailTaken
+      response = @api.register_new_user(email, password)
+
+      cache_info(response['user']) # cache account_info, saves an extra API call
+      authorize_token(response['token'])
+    end
+
+    # logout, rendering any auth_token useless
+    def logout
+      begin
+        @api.logout
+        authorize_token(nil)
+      rescue Api::NotAuthorized
+        # already logged out, or never logged in
+      end
+
+      true
+    end
+
+    # authorize the application either using a saved auth_token or ask for a new token
+    def authorize(auth_token = self.auth_token)
+      return true if auth_token and authorize_token(auth_token) # saved auth_tokens significantly speed up the authentication process
+
+      if block_given? and not authorize_ticket # if we cannot authorize the ticket, the user needs to visit a web page and give our app permission
+        yield authorize_url # the supplied block should instruct the user to visit this url, returning once they have
+        authorize_ticket # try authorizing again, assuming the user has authed now
+      end
+
+      authorized?
+    end
+
+    # tickets are used to associate authentication attempts, so each user needs their own ticket
+    def ticket
+      @ticket ||= @api.get_ticket['ticket']
+    end
+
+    # the user must visit this url to allow the application to access their account
+    def authorize_url(ticket = self.ticket)
+      "#{ api.url }/auth/#{ ticket }"
+    end
+
+    # using the ticket, we get the auth_token providing the user has already allowed our application the privilege
+    def authorize_ticket(ticket = self.ticket) # note: self.ticket will request a ticket if none exists, not the same as @ticket
+      begin
+        response = @api.get_auth_token(ticket)
+
+        cache_info(response['user']) # cache account_info, saves an extra API call
+        authorize_token(response['auth_token'])
+      rescue Api::NotAuthorized
+        false
+      end
+    end
+
+    # we have a token, and we have to save it and check if it is valid
+    def authorize_token(auth_token = self.auth_token)
+      @api.set_auth_token(auth_token)
+      @auth_token = auth_token if authorized? # set auth token if successful
+    end
+
+    # we are authorized if we have the user's account info
+    def authorized?
+      info != nil
+    end
+
+    # return the cached account info, or request it
+    def info
+      return @info if @info
+
+      begin
+        info = @api.get_account_info['user']
+        cache_info(info)
+      rescue Api::NotAuthorized, Api::InvalidInput
+        nil
+      end
+    end
+
+    # return the root of the user's folder structure
+    def root
+      return @root if @root
+      @root = Box::Folder.new(@api, nil, :id => 0)
+    end
+
+    protected
+
+    # cache account info, possibly from get_auth_token, register_new_user, or get_account_info
+    def cache_info(info)
+      @info = info
+    end
+  end
+end