contentful-management 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59a0b72970e30e8e4fa850361c2ed6c52603e6b0
-  data.tar.gz: b1f2d446a426a052a8ca164e1f9ca3a9b15f8212
+  metadata.gz: c880b5d6e4f5f9b5cf11599a5177de92c8cfb673
+  data.tar.gz: 57ed6666b81a6767b4c7d5b1b315d2bf64f3e7e2
 SHA512:
-  metadata.gz: d245df3cd7ab483f306fd8fb7823cfbe41bb3b93c4fa1798c8833ac6fcfdbbba4eb62b72c0ef5be78bcc963528ac0983436594c79005309262d83340eca1a199
-  data.tar.gz: 03b149bc58082a045ccda45820f07c590616a50c96ce3af8777ada574f6ab7f453b57f8197b754f687ea60f679f7c162020f5973b064ad783b47fa157ca42a3b
+  metadata.gz: e590866845d60f709bfd6b525f2a7a4ef779373e78e57881e375237f52ea54e3b66a52d221052cab7a572c3a609127cfbb8aa41a0cd3cddaca9a01e447dce278
+  data.tar.gz: f115b17339749173bdbd4c883b8d3cc0d99ceaa398f3b30639959a31ebcfc5751d01a9b61198deae79f5fd019d2c91b883836a2f06f95f8895ec1c4bc2c437af

data/.rubocop.yml

@@ -21,3 +21,6 @@ Metrics/LineLength:
 
 Metrics/ClassLength:
   Max: 250
+
+Style/SignalException:
+  EnforcedStyle: 'semantic'

data/.rubocop_todo.yml

@@ -8,7 +8,7 @@
 
 # Offense count: 12
 Metrics/AbcSize:
-  Max: 41
+  Max: 45
 
 # Offense count: 4
 Metrics/CyclomaticComplexity:
@@ -17,8 +17,8 @@ Metrics/CyclomaticComplexity:
 # Offense count: 18
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 24
+  Max: 25
 
 # Offense count: 2
 Metrics/PerceivedComplexity:
-  Max: 9
+  Max: 10

data/.travis.yml

@@ -1,13 +1,14 @@
 language: ruby
 rvm:
   - 2.2.3
+  - 2.3.1
+  - 2.4.0
   - 2.1.1
   - 2.1
   - 2.0.0
-  - 1.9.3
-  - jruby-19mode
+  - jruby-head
 
-before_install: gem install bundler -v 1.10.6
+before_install: gem install bundler
 script: bundle exec rake rspec_rubocop
 notifications:
   slack:

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Master
 
+## 1.7.0
+
+### Added
+* Added support for Upload API
+
 ## 1.6.0
 
 ### Added

data/Gemfile

@@ -4,13 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'guard'
-  gem 'listen', '3.0.0'
-  gem 'guard-rspec'
-  gem 'guard-rubocop'
   gem 'pry'
 end
-
-group :test do
-  gem 'simplecov', require: false
-end

data/Guardfile

@@ -1,29 +1,3 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-## Uncomment and set this to only include directories you want to watch
-# directories %w(app lib config test spec features) \
-#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
-
-## Note: if you are using the `directories` clause above and you are not
-## watching the project directory ('.'), then you will want to move
-## the Guardfile to a watched dir and symlink it back, e.g.
-#
-#  $ mkdir config
-#  $ mv Guardfile config/
-#  $ ln -s config/Guardfile .
-#
-# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
-
-# Note: The cmd option is now required due to the increasing number of ways
-#       rspec may be run, below are examples of the most common uses.
-#  * bundler: 'bundle exec rspec'
-#  * bundler binstubs: 'bin/rspec'
-#  * spring: 'bin/rspec' (This will use spring if running and you have
-#                          installed the spring binstubs per the docs)
-#  * zeus: 'zeus rspec' (requires the server to be started separately)
-#  * 'just' rspec: 'rspec'
-
 group :green_red_refactor, halt_on_fail: true do
   guard :rspec, cmd: "bundle exec rspec --format documentation" do
     require "guard/rspec/dsl"
@@ -40,36 +14,11 @@ group :green_red_refactor, halt_on_fail: true do
     # Ruby files
     ruby = dsl.ruby
     dsl.watch_spec_files_for(ruby.lib_files)
-
-    # Rails files
-    rails = dsl.rails(view_extensions: %w(erb haml slim))
-    dsl.watch_spec_files_for(rails.app_files)
-    dsl.watch_spec_files_for(rails.views)
-
-    watch(rails.controllers) do |m|
-      [
-        rspec.spec.("routing/#{m[1]}_routing"),
-        rspec.spec.("controllers/#{m[1]}_controller"),
-        rspec.spec.("acceptance/#{m[1]}")
-      ]
-    end
-
-    # Rails config changes
-    watch(rails.spec_helper)     { rspec.spec_dir }
-    watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
-    watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
-
-    # Capybara features specs
-    watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
-    watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
-
-    # Turnip features and steps
-    watch(%r{^spec/acceptance/(.+)\.feature$})
-    watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
-      Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
-    end
   end
 
   guard :rubocop, cmd: "rubocop" do
   end
+
+  guard :yard, cmd: "yard doc" do
+  end
 end

data/README.md

@@ -196,6 +196,51 @@ Checking if an asset is published:
 my_image_asset.published?
 ```
 
+### File Uploads
+
+Creating an upload from a file path:
+
+```ruby
+upload = client.uploads.create('space_id', '/path/to/file.md')
+```
+
+Alternatively, create it from an `::IO` object:
+
+```ruby
+File.open('/path/to/file.md', 'rb') do |file|
+  upload = client.uploads.create('space_id', file)
+end
+```
+
+Finding an upload:
+
+```ruby
+upload = client.uploads.find('space_id', 'upload_id')
+```
+
+Deleting an upload
+
+```ruby
+upload.destroy
+```
+
+Associating an upload with an asset:
+
+```ruby
+# We find or create an upload:
+upload = client.uploads.find('space_id', 'upload_id')
+
+# We create a File object with the associated upload:
+file = Contentful::Management::File.new
+file.properties[:contentType] = 'text/plain'
+file.properties[:fileName] = 'file.md'
+file.properties[:uploadFrom] = upload.to_link_json  # We create the Link from the upload.
+
+# We create an asset with the associated file:
+asset = client.assets.create('space_id', title: 'My Upload', file: file)
+asset.process_file  # We process the file, to generate an URL for our upload.
+```
+
 ### Entries
 
 Retrieving all entries from the space:

data/Rakefile

@@ -24,11 +24,6 @@ RSpec::Core::RakeTask.new
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
-require 'reek/rake/task'
-Reek::Rake::Task.new do |t|
-  t.fail_on_error = false
-end
-
 desc 'Run specs, rubocop and reek'
 task ci: %w(spec reek rubocop)
 

data/contentful-management.gemspec

@@ -17,19 +17,22 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'http', '~> 1.0'
+  spec.add_dependency 'http', '> 1.0', '< 3.0'
   spec.add_dependency 'multi_json', '~> 1'
   spec.add_dependency 'json', '~> 1.8'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '< 11.0'
   spec.add_development_dependency 'public_suffix', '< 1.5'
-
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rspec-its'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'reek', '~> 2.2.1'
-  spec.add_development_dependency 'unparser', '0.2.4'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'guard-yard'
+  spec.add_development_dependency 'rubocop', '~> 0.41.0'
+  spec.add_development_dependency 'listen', '3.0.0'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock', '~> 1', '>= 1.17.3'
+  spec.add_development_dependency 'simplecov'
 end

data/lib/contentful/management/client.rb

@@ -14,6 +14,7 @@ require 'contentful/management/client_locale_methods_factory'
 require 'contentful/management/client_role_methods_factory'
 require 'contentful/management/client_editor_interface_methods_factory'
 require 'contentful/management/client_webhook_methods_factory'
+require 'contentful/management/client_upload_methods_factory'
 require 'contentful/management/client_snapshot_methods_factory'
 
 require_relative 'request'
@@ -34,6 +35,7 @@ module Contentful
       # Default configuration for Contentful::Management::Client
       DEFAULT_CONFIGURATION = {
         api_url: 'api.contentful.com',
+        uploads_url: 'upload.contentful.com',
         api_version: '1',
         secure: true,
         default_locale: 'en-US',
@@ -48,9 +50,10 @@ module Contentful
         proxy_password: nil,
         max_rate_limit_retries: 1,
         max_rate_limit_wait: 60
-      }
+      }.freeze
+
       # Rate Limit Reset Header Key
-      RATE_LIMIT_RESET_HEADER_KEY = 'x-contentful-ratelimit-reset'
+      RATE_LIMIT_RESET_HEADER_KEY = 'x-contentful-ratelimit-reset'.freeze
 
       # @param [String] access_token
       # @param [Hash] configuration
@@ -156,6 +159,15 @@ module Contentful
         ClientWebhookMethodsFactory.new(self)
       end
 
+      # Allows manipulation of uploads in context of the current client
+      # Allows creating new and finding uploads by id.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientUploadMethodsFactory]
+      def uploads
+        ClientUploadMethodsFactory.new(self)
+      end
+
       # Allows manipulation of snapshots in context of the current client
       # Allows listing all webhooks for client, creating new and finding one by id.
       # @see _ README for details.
@@ -223,11 +235,11 @@ module Contentful
       # @private
       def execute_request(request)
         retries_left = configuration[:max_rate_limit_retries]
-        request_url = request.url
-        url = request.absolute? ? request_url : base_url + request_url
+        host = host_url(request)
+        url = request.absolute? ? request.url : host + request.url
 
         begin
-          logger.info(request: { url: url, query: request.query, header: request_headers }) if logger
+          logger.info(request: { url: url, query: request.query, header: request_headers(request) }) if logger
           raw_response = yield(url)
           logger.debug(response: raw_response) if logger
           clear_headers
@@ -237,10 +249,7 @@ module Contentful
           reset_time = rate_limit_error.response.raw[RATE_LIMIT_RESET_HEADER_KEY].to_i
           if should_retry(retries_left, reset_time, configuration[:max_rate_limit_wait])
             retries_left -= 1
-            retry_message = 'Contentful Management API Rate Limit Hit! '
-            retry_message += "Retrying - Retries left: #{retries_left}"
-            retry_message += "- Time until reset (seconds): #{reset_time}"
-            logger.info(retry_message) if logger
+            logger.info(retry_message(retries_left, reset_time)) if logger
             sleep(reset_time * Random.new.rand(1.0..1.2))
             retry
           end
@@ -251,6 +260,20 @@ module Contentful
         result
       end
 
+      # @private
+      def host_url(request)
+        (%r{^/[\w|-]+/uploads(?:/[\w|-]*)?$} =~ request.url) ? uploads_url : base_url
+      end
+
+      # @private
+      def retry_message(retries_left, reset_time)
+        retry_message = 'Contentful Management API Rate Limit Hit! '
+        retry_message += "Retrying - Retries left: #{retries_left}"
+        retry_message += "- Time until reset (seconds): #{reset_time}"
+
+        retry_message
+      end
+
       # @private
       def should_retry(retries_left, reset_time, max_wait)
         retries_left > 0 && max_wait > reset_time
@@ -266,28 +289,28 @@ module Contentful
       # @private
       def delete(request)
         execute_request(request) do |url|
-          self.class.delete_http(url, {}, request_headers, proxy_parameters)
+          self.class.delete_http(url, {}, request_headers(request), proxy_parameters)
         end
       end
 
       # @private
       def get(request)
         execute_request(request) do |url|
-          self.class.get_http(url, request.query, request_headers, proxy_parameters)
+          self.class.get_http(url, request.query, request_headers(request), proxy_parameters)
         end
       end
 
       # @private
       def post(request)
         execute_request(request) do |url|
-          self.class.post_http(url, request.query, request_headers, proxy_parameters)
+          self.class.post_http(url, request.query, request_headers(request), proxy_parameters)
         end
       end
 
       # @private
       def put(request)
         execute_request(request) do |url|
-          self.class.put_http(url, request.query, request_headers, proxy_parameters)
+          self.class.put_http(url, request.query, request_headers(request), proxy_parameters)
         end
       end
 
@@ -296,6 +319,11 @@ module Contentful
         "#{protocol}://#{configuration[:api_url]}/spaces"
       end
 
+      # @private
+      def uploads_url
+        "#{protocol}://#{configuration[:uploads_url]}/spaces"
+      end
+
       # @private
       def default_locale
         configuration[:default_locale]
@@ -348,7 +376,7 @@ module Contentful
 
       # @todo headers should be supplied differently, maybe through the request object.
       # @private
-      def request_headers
+      def request_headers(request = nil)
         headers = {}
         headers.merge! user_agent
         headers.merge! authentication_header
@@ -358,6 +386,8 @@ module Contentful
         headers.merge! zero_length_header if zero_length
         headers.merge! content_type_header(content_type_id) if content_type_id
         headers.merge! accept_encoding_header('gzip') if gzip_encoded
+
+        headers.merge! request.headers unless request.nil?
         headers
       end
 

data/lib/contentful/management/client_upload_methods_factory.rb

@@ -0,0 +1,19 @@
+require_relative 'client_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Upload API for usage from within Client
+    # @private
+    class ClientUploadMethodsFactory
+      include Contentful::Management::ClientAssociationMethodsFactory
+
+      def new(*)
+        fail 'Not supported'
+      end
+
+      def all(*)
+        fail 'Not supported'
+      end
+    end
+  end
+end

data/lib/contentful/management/content_type.rb

@@ -14,17 +14,17 @@ module Contentful
     class ContentType
       # Shortcuts for Contentful Field Types
       FIELD_TYPES = [
-        SYMBOL = 'Symbol',
-        TEXT = 'Text',
-        INTEGER = 'Integer',
-        FLOAT = 'Number',
-        DATE = 'Date',
-        BOOLEAN = 'Boolean',
-        LINK = 'Link',
-        ARRAY = 'Array',
-        OBJECT = 'Object',
-        LOCATION = 'Location'
-      ]
+        SYMBOL = 'Symbol'.freeze,
+        TEXT = 'Text'.freeze,
+        INTEGER = 'Integer'.freeze,
+        FLOAT = 'Number'.freeze,
+        DATE = 'Date'.freeze,
+        BOOLEAN = 'Boolean'.freeze,
+        LINK = 'Link'.freeze,
+        ARRAY = 'Array'.freeze,
+        OBJECT = 'Object'.freeze,
+        LOCATION = 'Location'.freeze
+      ].freeze
 
       include Contentful::Management::Resource
       include Contentful::Management::Resource::SystemProperties
@@ -42,9 +42,9 @@ module Contentful
         ClientContentTypeMethodsFactory
       end
 
-      alias_method :activate, :publish
-      alias_method :deactivate, :unpublish
-      alias_method :active?, :published?
+      alias activate publish
+      alias deactivate unpublish
+      alias active? published?
 
       # @private
       def self.create_attributes(_client, attributes)
@@ -97,7 +97,7 @@ module Contentful
       end
 
       # @private
-      alias_method :orig_fields, :fields
+      alias orig_fields fields
 
       # Use this method only in the context of content type.
       # Allows you to add and create a field with specified attributes or destroy by pass field id.
@@ -164,10 +164,10 @@ module Contentful
 
       def query_attributes(attributes)
         parameters = {}
-        parameters.merge!(displayField: display_field_value(attributes))
-        parameters.merge!(name: (attributes[:name] || name))
-        parameters.merge!(description: (attributes[:description] || description))
-        parameters.merge!(fields: self.class.fields_to_nested_properties_hash(attributes[:fields] || fields))
+        parameters[:displayField] = display_field_value(attributes)
+        parameters[:name] = attributes[:name] || name
+        parameters[:description] = attributes[:description] || description
+        parameters[:fields] = self.class.fields_to_nested_properties_hash(attributes[:fields] || fields)
 
         parameters.delete_if { |_, v| v.nil? }
       end