boxr 0.31.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8682c0e2402a646cae436c2d103074312f84e656
-  data.tar.gz: 9ab29d7ccf6b4c1b93816527515bfa0859898f2a
+  metadata.gz: 517251718a2a480a9558ec592e3a05fe77a0a176
+  data.tar.gz: bd500f4b3fbcbc8067dba9f177e4ed59dc8fb65e
 SHA512:
-  metadata.gz: 38f3c5d4aa1b0c98b4c33193318d3ab975e61a2f6a6ac11d634a39050f9ebdb048009c01270261d00c0e2ab6952b99bd610264c9edd60e1a4217d5132a6368a0
-  data.tar.gz: 0eb2bcac3782982da752cefa205befb4e14c61ecf6db4c750c82c36573b784631079c92abf000e381fe462263864616c78961d59816235b9feb73ca5ef0aa035
+  metadata.gz: ba654518f7ec93a4635903d5eea630aa35a55614f17dfbac74a41b71cf5d83ec2193b5b1d19fb892e1d80662bb89032533375201d2830127867372152585e14c
+  data.tar.gz: 00bf893d13ca76a97bad47fb23283468fcdfefe416f2443a6ce08257c9d7c8cedc5fab4d85d23896303b451a991d6636074f18418e43d1572305608c05a0630a

data/README.md

@@ -172,6 +172,11 @@ file_from_path(path)
 file_from_id(file_id, fields: [])
 alias :file :file_from_id
 
+embed_url(file)
+alias :embed_link :embed_url
+alias :preview_url :embed_url
+alias :preview_link :embed_url
+
 update_file(file, name: nil, description: nil, parent: nil, shared_link: nil, tags: nil, if_match: nil)
 
 lock_file(file, expires_at: nil, is_download_prevented: false, if_match: nil)
@@ -200,9 +205,6 @@ delete_old_version_of_file(file, file_version, if_match: nil)
 
 copy_file(file, parent, name: nil)
 
-embed_url(file, version: nil, disable_download: nil)
-alias :preview_url :embed_url
-
 thumbnail(file, min_height: nil, min_width: nil, max_height: nil, max_width: nil)
 
 create_shared_link_for_file(file, access: nil, unshared_at: nil, can_download: nil, can_preview: nil)
@@ -259,9 +261,12 @@ shared_item(shared_link, shared_link_password: nil)
 ```
 #### [Search](https://developers.box.com/docs/#search)
 ```ruby
-search(query, scope: nil, file_extensions: nil, created_at_range: nil, updated_at_range: nil, size_range: nil, 
-        owner_user_ids: nil, ancestor_folder_ids: nil, content_types: nil, type: nil, 
-        limit: 30, offset: 0)
+search( query=nil, scope: nil, file_extensions: [], 
+        created_at_range_from_date: nil, created_at_range_to_date: nil,
+        updated_at_range_from_date: nil, updated_at_range_to_date: nil,
+        size_range_lower_bound_bytes: nil, size_range_upper_bound_bytes: nil, 
+        owner_user_ids: [], ancestor_folder_ids: [], content_types: [], trash_content: nil, 
+        mdfilters: nil, type: nil, limit: 30, offset: 0)
 ```
 #### [Users](https://developers.box.com/docs/#users)
 ```ruby
@@ -349,9 +354,15 @@ create_metadata(file, metadata, scope: :global, template: :properties)
 
 metadata(file, scope: :global, template: :properties)
 
+all_metadata(file)
+
 update_metadata(file, updates, scope: :global, template: :properties)
 
 delete_metadata(file, scope: :global, template: :properties)
+
+enterprise_metadata
+
+metadata_schema(scope, template_key)
 ```
 ## Contributing
 

data/lib/boxr/client.rb

@@ -23,8 +23,10 @@ module Boxr
     TASK_ASSIGNMENTS_URI = "#{API_URI}/task_assignments"
     SHARED_ITEMS_URI = "#{API_URI}/shared_items"
     METADATA_URI = "#{API_URI}/files"
+    METADATA_TEMPLATES_URI = "#{API_URI}/metadata_templates"
     EVENTS_URI = "#{API_URI}/events"
 
+
     DEFAULT_LIMIT = 100
     FOLDER_ITEMS_LIMIT = 1000
 
@@ -251,6 +253,22 @@ module Boxr
       end
     end
 
+    def to_comma_separated_string(values)
+      return values if values.is_a?(String) || values.is_a?(Symbol)
+
+      if values.is_a?(Array) && values.length > 0
+        values.join(',')
+      else
+        nil
+      end
+    end
+
+    def build_range_string(from, to)
+      range_string = "#{from},#{to}"
+      range_string = nil if range_string == ","
+      range_string
+    end
+
     def ensure_id(item)
       return item if item.class == String || item.class == Fixnum || item.nil?
       return item.id if item.respond_to?(:id)

data/lib/boxr/metadata.rb

@@ -15,6 +15,13 @@ module Boxr
       metadata
     end
 
+    def all_metadata(file)
+      file_id = ensure_id(file)
+      uri = "#{METADATA_URI}/#{file_id}/metadata"
+      all_metadata, response = get(uri)
+      all_metadata
+    end
+
     def update_metadata(file, updates, scope: :global, template: :properties)
       file_id = ensure_id(file)
       uri = "#{METADATA_URI}/#{file_id}/metadata/#{scope}/#{template}"
@@ -33,5 +40,17 @@ module Boxr
       result
     end
 
+    def enterprise_metadata
+      uri = "#{METADATA_TEMPLATES_URI}/enterprise"
+      ent_metadata, response = get(uri)
+      ent_metadata
+    end
+
+    def metadata_schema(scope, template_key)
+      uri = "#{METADATA_TEMPLATES_URI}/#{scope}/#{template_key}/schema"
+      schema, response = get(uri)
+      schema
+    end
+
   end
 end

data/lib/boxr/search.rb

@@ -1,26 +1,67 @@
 module Boxr
   class Client
 
-    def search(query, scope: nil, file_extensions: nil, created_at_range: nil, updated_at_range: nil, size_range: nil, 
-                      owner_user_ids: nil, ancestor_folder_ids: nil, content_types: nil, type: nil, 
-                      limit: 30, offset: 0)
-
-      query = {query: query}
-      query[:scope] = scope unless scope.nil?
-      query[:file_extensions] = file_extensions unless file_extensions.nil?
-      query[:created_at_range] = created_at_range unless created_at_range.nil?
-      query[:updated_at_range] = updated_at_range unless updated_at_range.nil?
-      query[:size_range] = size_range unless size_range.nil?
-      query[:owner_user_ids] = owner_user_ids unless owner_user_ids.nil?
-      query[:ancestor_folder_ids] = ancestor_folder_ids unless ancestor_folder_ids.nil?
-      query[:content_types] = content_types unless content_types.nil?
-      query[:type] = type unless type.nil?
-      query[:limit] = limit unless limit.nil?
-      query[:offset] = offset unless offset.nil?
-
-      results, response = get(SEARCH_URI, query: query)
+    def search( query=nil, scope: nil, file_extensions: [], 
+                created_at_range_from_date: nil, created_at_range_to_date: nil,
+                updated_at_range_from_date: nil, updated_at_range_to_date: nil,
+                size_range_lower_bound_bytes: nil, size_range_upper_bound_bytes: nil, 
+                owner_user_ids: [], ancestor_folder_ids: [], content_types: [], trash_content: nil, 
+                mdfilters: nil, type: nil, limit: 30, offset: 0)
+
+      
+      unless mdfilters.nil?
+        unless mdfilters.is_a? String   #if a string is passed in assume it is already formatted correctly
+          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) 
+        end
+      end
+
+      #build range strings
+      created_at_range_string = build_date_range_field(created_at_range_from_date, created_at_range_to_date)
+      updated_at_range_string = build_date_range_field(updated_at_range_from_date, updated_at_range_to_date)
+      size_range_string = build_size_range_field(size_range_lower_bound_bytes, size_range_upper_bound_bytes)
+
+      #build comma separated strings
+      file_extensions_string = to_comma_separated_string(file_extensions)
+      owner_user_ids_string = to_comma_separated_string(owner_user_ids)
+      ancestor_folder_ids_string = to_comma_separated_string(ancestor_folder_ids)
+      content_types_string = to_comma_separated_string(content_types)
+
+      search_query = {}
+      search_query[:query] = query unless query.nil?
+      search_query[:scope] = scope unless scope.nil?
+      search_query[:file_extensions] = file_extensions_string unless file_extensions_string.nil?
+      search_query[:created_at_range] = created_at_range_string unless created_at_range_string.nil?
+      search_query[:updated_at_range] = updated_at_range_string unless updated_at_range_string.nil?
+      search_query[:size_range] = size_range_string unless size_range_string.nil?
+      search_query[:owner_user_ids] = owner_user_ids_string unless owner_user_ids_string.nil?
+      search_query[:ancestor_folder_ids] = ancestor_folder_ids_string unless ancestor_folder_ids_string.nil?
+      search_query[:content_types] = content_types_string unless content_types_string.nil?
+      search_query[:trash_content] = trash_content unless trash_content.nil?
+      search_query[:mdfilters] = mdfilters unless mdfilters.nil?
+      search_query[:type] = type unless type.nil?
+      search_query[:limit] = limit unless limit.nil?
+      search_query[:offset] = offset unless offset.nil?
+
+      results, response = get(SEARCH_URI, query: search_query)
       results.entries
     end
 
+    private
+
+    def build_date_range_field(from, to)
+      from_string = from.nil? ? "" : from.to_datetime.rfc3339
+      to_string = to.nil? ? "" : to.to_datetime.rfc3339
+      build_range_string(from_string, to_string)
+    end
+
+    def build_size_range_field(lower, upper)
+      lower_string = lower.nil? ? "" : lower.to_i
+      upper_string = upper.nil? ? "" : upper.to_i
+      build_range_string(lower_string, upper_string)
+    end
+
   end
 end

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "0.31.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chad Burnette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2015-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler