boxr 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dabf6e02613d429dee655d87eaacacdd8bba2386
-  data.tar.gz: d5f56cea3324cdadc93ace1b5d06aaf57f127f0b
+  metadata.gz: 6b219a0546f48304aa3786f78c7fee4633b2a93e
+  data.tar.gz: 24e175d1d4d4164c7d9fe493ffe58e9961e6ee68
 SHA512:
-  metadata.gz: 5560f56757e1b129227fc0303fdb708054dc673f04afb262dc83dd4efe547f254c58d5ac71b4c9924990d18d1ba5e4e217ce4aa8c5ff7e56e02a91197f748fec
-  data.tar.gz: dea07c12287232c34ca1be07d38c9a6b34677ca5d3048c35ac23b09004115e67091c53eb4c5d0e110606a89d5d27741a7f5b230e756cb25c6fdfb426f2f1ce21
+  metadata.gz: a1ae72b408546796a1f22e3870afd2b2adecc2cd8016269d64df8849662dbf8eeb45e076987cbe9f8ad88a199403be98896e01fd491905f84798a3fc9a2028b4
+  data.tar.gz: 5532462b58dca43097386ba4ccdf52d0f04b3f318dbe160548903075bc333a3433023c4223ee8a2a929fd0462a8a0b99f296be9311e05b06bbfcbb1b9268a7cb

data/README.md

@@ -368,6 +368,16 @@ enterprise_metadata
 
 metadata_schema(scope, template_key)
 ```
+#### [Web Links](https://box-content.readme.io/reference#web-link-object)
+```ruby
+create_web_link(url, parent, name: nil, description: nil)
+
+get_web_link(web_link)
+
+update_web_link(web_link_id, url: nil, parent: nil, name: nil, description: nil)
+
+delete_web_link(web_link)
+```
 ## Contributing
 
 1. Fork it ( https://github.com/cburnette/boxr/fork )

data/Rakefile

@@ -8,4 +8,3 @@ RSpec::Core::RakeTask.new(:spec) do |task|
 end
 
 task :default => :spec
-

data/bin/boxr

@@ -6,4 +6,4 @@ require 'awesome_print'
 require 'irb'
 
 $boxr = Boxr::Client.new #uses ENV['BOX_DEVELOPER_TOKEN']
-IRB.start
+IRB.start

data/lib/boxr.rb

@@ -21,6 +21,7 @@ require 'boxr/tasks'
 require 'boxr/metadata'
 require 'boxr/events'
 require 'boxr/auth'
+require 'boxr/web_links'
 
 module Enumerable
   def files
@@ -58,7 +59,7 @@ module Boxr
   BOX_CLIENT.cookie_manager = nil
   BOX_CLIENT.send_timeout = 3600 #one hour; needed for lengthy uploads
   BOX_CLIENT.agent_name = "Boxr/#{Boxr::VERSION}"
-  BOX_CLIENT.transparent_gzip_decompression = true 
+  BOX_CLIENT.transparent_gzip_decompression = true
   #BOX_CLIENT.ssl_config.add_trust_ca("/Users/cburnette/code/ssh-keys/dev_root_ca.pem")
 
   def self.turn_on_debugging(device=STDOUT)
@@ -72,4 +73,4 @@ module Boxr
     BOX_CLIENT.transparent_gzip_decompression = true
     nil
   end
-end
+end

data/lib/boxr/client.rb

@@ -1,5 +1,5 @@
 module Boxr
-  
+
   class Client
 
     attr_reader :access_token, :refresh_token, :client_id, :client_secret, :identifier, :as_user_id
@@ -26,6 +26,7 @@ module Boxr
     FOLDER_METADATA_URI = "#{API_URI}/folders"
     METADATA_TEMPLATES_URI = "#{API_URI}/metadata_templates"
     EVENTS_URI = "#{API_URI}/events"
+    WEB_LINKS_URI = "#{API_URI}/web_links"
 
 
     DEFAULT_LIMIT = 100
@@ -35,13 +36,12 @@ module Boxr
                               :size,:path_collection,:created_by,:modified_by,:trashed_at,:purged_at,
                               :content_created_at,:content_modified_at,:owned_by,:shared_link,:folder_upload_email,
                               :parent,:item_status,:item_collection,:sync_state,:has_collaborations,:permissions,:tags,
-                              :sha1,:shared_link,:version_number,:comment_count,:lock,:extension,:is_package,
-                              :expiring_embed_link, :can_non_owners_invite]
+                              :sha1,:shared_link,:version_number,:comment_count,:lock,:extension,:is_package,:can_non_owners_invite]
     FOLDER_AND_FILE_FIELDS_QUERY = FOLDER_AND_FILE_FIELDS.join(',')
 
     COMMENT_FIELDS = [:type,:id,:is_reply_comment,:message,:tagged_message,:created_by,:created_at,:item,:modified_at]
     COMMENT_FIELDS_QUERY = COMMENT_FIELDS.join(',')
-    
+
     TASK_FIELDS = [:type,:id,:item,:due_at,:action,:message,:task_assignment_collection,:is_completed,:created_by,:created_at]
     TASK_FIELDS_QUERY = TASK_FIELDS.join(',')
 
@@ -58,18 +58,18 @@ module Boxr
     GROUP_FIELDS_QUERY = GROUP_FIELDS.join(',')
 
     VALID_COLLABORATION_ROLES = ['editor','viewer','previewer','uploader','previewer uploader','viewer uploader','co-owner','owner']
-    
 
-    def initialize( access_token=ENV['BOX_DEVELOPER_TOKEN'], 
-                    refresh_token: nil, 
-                    client_id: ENV['BOX_CLIENT_ID'], 
+
+    def initialize( access_token=ENV['BOX_DEVELOPER_TOKEN'],
+                    refresh_token: nil,
+                    client_id: ENV['BOX_CLIENT_ID'],
                     client_secret: ENV['BOX_CLIENT_SECRET'],
                     enterprise_id: ENV['BOX_ENTERPRISE_ID'],
-                    jwt_private_key: ENV['JWT_PRIVATE_KEY'], 
+                    jwt_private_key: ENV['JWT_PRIVATE_KEY'],
                     jwt_private_key_password: ENV['JWT_PRIVATE_KEY_PASSWORD'],
                     jwt_public_key_id: ENV['JWT_PUBLIC_KEY_ID'],
-                    identifier: nil, 
-                    as_user: nil, 
+                    identifier: nil,
+                    as_user: nil,
                     &token_refresh_listener)
 
       @access_token = access_token
@@ -121,7 +121,7 @@ module Boxr
           headers = standard_headers
           BOX_CLIENT.get(uri, query: query, header: headers, follow_redirect: follow_redirect)
         end
-        
+
         if (res.status==200)
           body_json = Oj.load(res.body)
           total_count = body_json["total_count"]
@@ -161,7 +161,7 @@ module Boxr
         headers = standard_headers
         headers['If-Match'] = if_match unless if_match.nil?
         headers["Content-Type"] = content_type unless content_type.nil?
-        
+
         BOX_CLIENT.put(uri, body: Oj.dump(body), query: query, header: headers)
       end
 
@@ -176,7 +176,7 @@ module Boxr
       res = with_auto_token_refresh do
         headers = standard_headers
         headers['If-Match'] = if_match unless if_match.nil?
-        
+
         BOX_CLIENT.delete(uri, query: query, header: headers)
       end
 
@@ -282,7 +282,7 @@ module Boxr
       attributes = {}
       attributes[:name] = name unless name.nil?
       attributes[:parent] = {id: parent_id} unless parent_id.nil?
-      
+
       restored_item, response = post(uri, attributes)
       restored_item
     end
@@ -307,4 +307,4 @@ module Boxr
 
   end
 
-end
+end

data/lib/boxr/folders.rb

@@ -50,7 +50,7 @@ module Boxr
 
       uri = "#{FOLDERS_URI}"
       attributes = {:name => name, :parent => {:id => parent_id}}
-      
+
       created_folder, response = post(uri, attributes)
       created_folder
     end
@@ -71,7 +71,7 @@ module Boxr
       attributes[:folder_upload_email] = {access: folder_upload_email_access} unless folder_upload_email_access.nil?
       attributes[:owned_by] = {id: owned_by_id} unless owned_by_id.nil?
       attributes[:sync_state] = sync_state unless sync_state.nil?
-      attributes[:tags] = tags unless tags.nil? 
+      attributes[:tags] = tags unless tags.nil?
       attributes[:can_non_owners_invite] = can_non_owners_invite unless can_non_owners_invite.nil?
 
       updated_folder, response = put(uri, attributes, if_match: if_match)
@@ -133,7 +133,7 @@ module Boxr
       folder_id = ensure_id(folder)
       uri = "#{FOLDERS_URI}/#{folder_id}/trash"
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
-      
+
       folder, response = get(uri, query: query)
       folder
     end
@@ -154,4 +154,4 @@ module Boxr
     end
 
   end
-end
+end

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/boxr/web_links.rb

@@ -0,0 +1,62 @@
+module Boxr
+  class Client
+
+    def create_web_link(url, parent, name: nil, description: nil)
+
+      parent_id = ensure_id(parent)
+      web_link_url = verify_url(url)
+      uri = "#{WEB_LINKS_URI}"
+
+      attributes = {}
+      attributes[:url] = web_link_url
+      attributes[:parent] = {:id => parent_id}
+      attributes[:name] = name unless name.nil?
+      attributes[:description] = description unless description.nil?
+
+      created_link, response = post(uri, attributes)
+      created_link
+    end
+
+    def get_web_link(web_link)
+
+      web_link_id = ensure_id(web_link)
+      uri = "#{WEB_LINKS_URI}/#{web_link_id}"
+
+      web_link, response = get(uri)
+      web_link
+    end
+
+    def update_web_link(web_link, url: nil, parent: nil, name: nil, description: nil)
+
+      web_link_id = ensure_id(web_link)
+      parent_id = ensure_id(parent)
+      uri = "#{WEB_LINKS_URI}/#{web_link_id}"
+
+      attributes = {}
+      attributes[:url] = url unless url.nil?
+      attributes[:name] = name unless name.nil?
+      attributes[:description] = description unless description.nil?
+      attributes[:parent] = {id: parent_id} unless parent_id.nil?
+
+      updated_web_link, response = put(uri, attributes)
+      updated_web_link
+    end
+
+    def delete_web_link(web_link)
+
+      web_link_id = ensure_id(web_link)
+      uri = "#{WEB_LINKS_URI}/#{web_link_id}"
+
+      result, response = delete(uri)
+      result
+    end
+
+    private
+
+    def verify_url(item)
+      return item if item.class == String and (item.include? 'https://' or item.include? 'http://')
+      raise BoxrError.new(boxr_message: "Invalid url. Must include 'http://' or 'https://'")
+    end
+
+  end
+end

data/spec/boxr_spec.rb

@@ -18,7 +18,7 @@ describe Boxr::Client do
   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
+  # Boxr::turn_on_debugging
 
   BOX_SERVER_SLEEP = 5
   TEST_FOLDER_NAME = 'Boxr Test'
@@ -34,6 +34,8 @@ describe Boxr::Client do
   TEST_USER_NAME = "Test Boxr User"
   TEST_GROUP_NAME= "Test Boxr Group"
   TEST_TASK_MESSAGE = "Please review"
+  TEST_WEB_URL = 'https://www.box.com'
+  TEST_WEB_URL2 = 'https://www.google.com'
 
   before(:each) do
     puts "-----> Resetting Box Environment"
@@ -62,8 +64,8 @@ describe Boxr::Client do
     end
   end
 
-  #use this command to just execute this scenario
-  #rake spec SPEC_OPTS="-e \"invokes folder operations"\"
+  # use this command to just execute this scenario
+  # rake spec SPEC_OPTS="-e \"invokes folder operations"\"
   it 'invokes folder operations' do
     puts "get folder using path"
     folder = BOX_CLIENT.folder_from_path(TEST_FOLDER_NAME)
@@ -244,6 +246,25 @@ describe Boxr::Client do
     expect(result).to eq({})
   end
 
+  #rake spec SPEC_OPTS="-e \"invokes web links operations"\"
+  it 'invokes web links operations' do
+    puts "create web link"
+    web_link = BOX_CLIENT.create_web_link(TEST_WEB_URL, '0', name: "my new link", description: "link description...")
+    expect(web_link.url).to eq(TEST_WEB_URL)
+
+    puts "get web link"
+    web_link_new = BOX_CLIENT.get_web_link(web_link)
+    expect(web_link_new.id).to eq(web_link.id)
+
+    puts "update web link"
+    updated_web_link = BOX_CLIENT.update_web_link(web_link, name: 'new name', description: 'new description', url: TEST_WEB_URL2)
+    expect(updated_web_link.url).to eq(TEST_WEB_URL2)
+
+    puts "delete web link"
+    result = BOX_CLIENT.delete_web_link(web_link)
+    expect(result).to eq({})
+  end
+
   #rake spec SPEC_OPTS="-e \"invokes user operations"\"
   it "invokes user operations" do
     puts "inspect current user"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Chad Burnette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,6 +219,7 @@ files:
 - lib/boxr/tasks.rb
 - lib/boxr/users.rb
 - lib/boxr/version.rb
+- lib/boxr/web_links.rb
 - spec/boxr_spec.rb
 - spec/spec_helper.rb
 - spec/test_files/test file.txt