boxr 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b219a0546f48304aa3786f78c7fee4633b2a93e
-  data.tar.gz: 24e175d1d4d4164c7d9fe493ffe58e9961e6ee68
+  metadata.gz: c454c797a01d524a1d291f614b6cbc325cd3b752
+  data.tar.gz: 706e102052b88ddbb8f2728bfc259a2352d6da08
 SHA512:
-  metadata.gz: a1ae72b408546796a1f22e3870afd2b2adecc2cd8016269d64df8849662dbf8eeb45e076987cbe9f8ad88a199403be98896e01fd491905f84798a3fc9a2028b4
-  data.tar.gz: 5532462b58dca43097386ba4ccdf52d0f04b3f318dbe160548903075bc333a3433023c4223ee8a2a929fd0462a8a0b99f296be9311e05b06bbfcbb1b9268a7cb
+  metadata.gz: ea87475ea281d5fa10a3d48bc8fec22dceec7bd2fe13f8e3e4166a230393c6925bd0b9b342ab99e15b5a7cceb2d7778a3601bf06aae7bb959dd52bd87393dc6d
+  data.tar.gz: f31f1792ab1e85af9f091d5fedbbbc1ba03ce31092abdc98300275e82e9d680f3f6c18fc7593f089a6994b2313e46d812d7005a297e9905697fca78fe5e445f4

data/README.md

@@ -111,6 +111,16 @@ updated_file = client.create_shared_link_for_file(file, access: :open)
 puts "Shared Link: #{updated_file.shared_link.url}"
 ```
 
+### NOTE: Using HTTP mocking libraries for testing
+When using HTTP mocking libraries for testing, you may need to set Boxr::BOX_CLIENT to a fresh instance of HTTPClient in your test setup after loading the HTTP mocking library. For example, when using WebMock with RSpec you might could add the following to your RSpec configuration:
+``` ruby
+RSpec.configure do |config|
+  config.before(:suite) do
+    Boxr::BOX_CLIENT = HTTPClient.new
+  end
+end
+```
+
 ### Methods
 #### [OAuth & JWT](https://box-content.readme.io/reference#oauth-2)
 ```ruby
@@ -172,7 +182,7 @@ file_from_path(path)
 file_from_id(file_id, fields: [])
 alias :file :file_from_id
 
-embed_url(file)
+def embed_url(file, show_download: false, show_annotations: false)
 alias :embed_link :embed_url
 alias :preview_url :embed_url
 alias :preview_link :embed_url
@@ -217,6 +227,16 @@ delete_trashed_file(file)
 
 restore_trashed_file(file, name: nil, parent: nil)
 ```
+#### [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, url: nil, parent: nil, name: nil, description: nil)
+
+delete_web_link(web_link)
+```
 #### [Comments](https://box-content.readme.io/reference#comment-object)
 ```ruby
 file_comments(file, fields: [], offset: 0, limit: DEFAULT_LIMIT)
@@ -368,15 +388,20 @@ enterprise_metadata
 
 metadata_schema(scope, template_key)
 ```
-#### [Web Links](https://box-content.readme.io/reference#web-link-object)
+
+#### [Watermarking](https://box-content.readme.io/reference#watermarking)
 ```ruby
-create_web_link(url, parent, name: nil, description: nil)
+get_watermark_on_file(file)
 
-get_web_link(web_link)
+apply_watermark_on_file(file)
 
-update_web_link(web_link_id, url: nil, parent: nil, name: nil, description: nil)
+remove_watermark_on_file(file)
 
-delete_web_link(web_link)
+get_watermark_on_folder(folder)
+
+apply_watermark_on_folder(folder)
+
+remove_watermark_on_folder(folder)
 ```
 ## Contributing
 

data/boxr.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Boxr::VERSION
   spec.authors       = ["Chad Burnette"]
   spec.email         = ["chadburnette@me.com"]
-  spec.summary       = "A Ruby client library for the Box V2 Content API that covers 100% of the underlying REST API."
+  spec.summary       = "A Ruby client library for the Box V2 Content API."
   spec.description   = ""
   spec.homepage      = "https://github.com/cburnette/boxr"
   spec.license       = "MIT"
@@ -28,9 +28,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "lru_redux", "~> 0.8"
 
-  spec.add_runtime_dependency "oj", "~> 2.11"
-  spec.add_runtime_dependency "httpclient", "~> 2.5"
-  spec.add_runtime_dependency "hashie", "~> 3.3"
+  spec.add_runtime_dependency "httpclient", "~> 2.8"
+  spec.add_runtime_dependency "hashie", "~> 3.5"
   spec.add_runtime_dependency "addressable", "~> 2.3"
   spec.add_runtime_dependency "jwt", "~> 1.4"
 end

data/lib/boxr.rb

@@ -1,4 +1,4 @@
-require 'oj'
+require 'json'
 require 'httpclient'
 require 'hashie'
 require 'addressable/template'
@@ -22,6 +22,7 @@ require 'boxr/metadata'
 require 'boxr/events'
 require 'boxr/auth'
 require 'boxr/web_links'
+require 'boxr/watermarking'
 
 module Enumerable
   def files
@@ -38,6 +39,9 @@ module Enumerable
 end
 
 class BoxrMash < Hashie::Mash
+
+  self.disable_warnings
+
   def entries
     self["entries"]
   end
@@ -48,8 +52,6 @@ class BoxrMash < Hashie::Mash
 end
 
 module Boxr
-  Oj.default_options = {:mode => :compat }
-
   #The root folder in Box is always identified by 0
   ROOT = 0
 

data/lib/boxr/auth.rb

@@ -84,7 +84,7 @@ module Boxr
     res = BOX_CLIENT.post(uri, body: body)
 
     if(res.status==200)
-      body_json = Oj.load(res.body)
+      body_json = JSON.load(res.body)
       return BoxrMash.new(body_json)
     else
       raise BoxrError.new(status: res.status, body: res.body, header: res.header)

data/lib/boxr/client.rb

@@ -123,7 +123,7 @@ module Boxr
         end
 
         if (res.status==200)
-          body_json = Oj.load(res.body)
+          body_json = JSON.load(res.body)
           total_count = body_json["total_count"]
           offset = offset + limit
 
@@ -138,7 +138,7 @@ module Boxr
 
     def post(uri, body, query: nil, success_codes: [201], process_body: true, content_md5: nil, content_type: nil, if_match: nil)
       uri = Addressable::URI.encode(uri)
-      body = Oj.dump(body) if process_body
+      body = JSON.dump(body) if process_body
 
       res = with_auto_token_refresh do
         headers = standard_headers
@@ -154,7 +154,7 @@ module Boxr
       processed_response(res)
     end
 
-    def put(uri, body, query: nil, success_codes: [200], content_type: nil, if_match: nil)
+    def put(uri, body, query: nil, success_codes: [200, 201], content_type: nil, if_match: nil)
       uri = Addressable::URI.encode(uri)
 
       res = with_auto_token_refresh do
@@ -162,7 +162,7 @@ module Boxr
         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)
+        BOX_CLIENT.put(uri, body: JSON.dump(body), query: query, header: headers)
       end
 
       check_response_status(res, success_codes)
@@ -190,7 +190,7 @@ module Boxr
 
       res = with_auto_token_refresh do
         headers = standard_headers
-        BOX_CLIENT.options(uri, body: Oj.dump(body), header: headers)
+        BOX_CLIENT.options(uri, body: JSON.dump(body), header: headers)
       end
 
       check_response_status(res, success_codes)
@@ -207,7 +207,7 @@ module Boxr
     end
 
     def with_auto_token_refresh
-      return yield unless @refresh_token or @jwt_secret_key
+      return yield unless @refresh_token or @jwt_private_key
 
       res = yield
       if res.status == 401
@@ -240,7 +240,7 @@ module Boxr
     end
 
     def processed_response(res)
-      body_json = Oj.load(res.body)
+      body_json = JSON.load(res.body)
       return BoxrMash.new(body_json), res
     end
 

data/lib/boxr/errors.rb

@@ -12,7 +12,7 @@ module Boxr
 
       if(body)
         begin
-          body_json = Oj.load(body)
+          body_json = JSON.load(body)
 
           if body_json
             @type = body_json["type"]

data/lib/boxr/files.rb

@@ -26,9 +26,9 @@ module Boxr
     end
     alias :file :file_from_id
 
-    def embed_url(file)
+    def embed_url(file, show_download: false, show_annotations: false)
       file_info = file_from_id(file, fields:[:expiring_embed_link])
-      url = file_info.expiring_embed_link.url
+      url = file_info.expiring_embed_link.url + "?showDownload=#{show_download}&showAnnotations=#{show_annotations}"
       url
     end
     alias :embed_link :embed_url
@@ -79,7 +79,7 @@ module Boxr
         uri = "#{FILES_URI}/#{file_id}/content"
         query = {}
         query[:version] = version unless version.nil?
-        body_json, response = get(uri, query: query, success_codes: [302,202], follow_redirect: false) #we don't want httpclient to automatically follow the redirect; we need to grab it
+        body_json, response = get(uri, query: query, success_codes: [302,202], process_response: false, follow_redirect: false) #we don't want httpclient to automatically follow the redirect; we need to grab it
 
         if(response.status==302)
           location = response.header['Location'][0]
@@ -120,7 +120,7 @@ module Boxr
         attributes[:content_created_at] = content_created_at.to_datetime.rfc3339 unless content_created_at.nil?
         attributes[:content_modified_at] = content_modified_at.to_datetime.rfc3339 unless content_modified_at.nil?
 
-        body = {attributes: Oj.dump(attributes), file: file}
+        body = {attributes: JSON.dump(attributes), file: file}
 
         file_info, response = post(FILES_UPLOAD_URI, body, process_body: false, content_md5: content_md5)
       end

data/lib/boxr/search.rb

@@ -14,7 +14,7 @@ module Boxr
           unless mdfilters.is_a? Array  
             mdfilters = [mdfilters]     #if just one mdfilter is specified ensure that it is packaged inside an array
           end
-          mdfilters = Oj.dump(mdfilters) 
+          mdfilters = JSON.dump(mdfilters) 
         end
       end
 

data/lib/boxr/version.rb

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

data/lib/boxr/watermarking.rb

@@ -0,0 +1,66 @@
+module Boxr
+  class Client
+
+    def get_watermark_on_file(file)
+
+      file_id = ensure_id(file)
+      uri = "#{FILES_URI}/#{file_id}/watermark"
+
+      file, response = get(uri)
+      file
+    end
+
+    def apply_watermark_on_file(file)
+
+      file_id = ensure_id(file)
+      uri = "#{FILES_URI}/#{file_id}/watermark"
+
+      attributes = {}
+      attributes[:watermark] = {:imprint => "default"}
+
+      file, response = put(uri, attributes, content_type: "application/json")
+      file
+    end
+
+    def remove_watermark_on_file(file)
+
+      file_id = ensure_id(file)
+      uri = "#{FILES_URI}/#{file_id}/watermark"
+
+      result, response = delete(uri)
+      result
+    end
+
+    def get_watermark_on_folder(folder)
+
+      folder_id = ensure_id(folder)
+      uri = "#{FOLDERS_URI}/#{folder_id}/watermark"
+
+      folder, response = get(uri)
+      folder
+    end
+
+    def apply_watermark_on_folder(folder)
+
+      folder_id = ensure_id(folder)
+      uri = "#{FOLDERS_URI}/#{folder_id}/watermark"
+
+      attributes = {}
+      attributes[:watermark] = {:imprint => "default"}
+
+      folder, response = put(uri, attributes, content_type: "application/json")
+      folder
+    end
+
+    def remove_watermark_on_folder(folder)
+
+      folder_id = ensure_id(folder)
+      uri = "#{FOLDERS_URI}/#{folder_id}/watermark"
+
+      result, response = delete(uri)
+      result
+    end
+
+
+  end
+end

data/spec/boxr_spec.rb

@@ -265,6 +265,36 @@ describe Boxr::Client do
     expect(result).to eq({})
   end
 
+  #rake spec SPEC_OPTS="-e \"invokes watermarking operations"\"
+  it 'invokes watermarking operations' do
+    test_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder)
+    folder = BOX_CLIENT.folder(@test_folder)
+
+    puts "apply watermark on file"
+    watermark = BOX_CLIENT.apply_watermark_on_file(test_file)
+    expect(watermark.watermark).to_not be_nil
+
+    puts "get watermark on file"
+    watermark = BOX_CLIENT.get_watermark_on_file(test_file)
+    expect(watermark.watermark).to_not be_nil
+
+    puts "remove watermark on file"
+    result = BOX_CLIENT.remove_watermark_on_file(test_file)
+    expect(result).to eq({})
+
+    puts "apply watermark on folder"
+    watermark = BOX_CLIENT.apply_watermark_on_folder(folder)
+    expect(watermark.watermark).to_not be_nil
+
+    puts "get watermark on folder"
+    watermark = BOX_CLIENT.get_watermark_on_folder(folder)
+    expect(watermark.watermark).to_not be_nil
+
+    puts "remove watermark on folder"
+    result = BOX_CLIENT.remove_watermark_on_folder(folder)
+    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.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Chad Burnette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2017-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,48 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.11'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +205,7 @@ files:
 - lib/boxr/tasks.rb
 - lib/boxr/users.rb
 - lib/boxr/version.rb
+- lib/boxr/watermarking.rb
 - lib/boxr/web_links.rb
 - spec/boxr_spec.rb
 - spec/spec_helper.rb
@@ -243,11 +230,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
-summary: A Ruby client library for the Box V2 Content API that covers 100% of the
-  underlying REST API.
+summary: A Ruby client library for the Box V2 Content API.
 test_files:
 - spec/boxr_spec.rb
 - spec/spec_helper.rb