contentful-management 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7374c6a0e9550339b72a54bc9e834b7f3bca3a8a
-  data.tar.gz: 058292ffa85f933dc083712cd918cdd91ecea921
+  metadata.gz: 4351225d59ca9af60725c79bd71d0717449e68e6
+  data.tar.gz: fd90f9d188c96f5446f9f920fe6272ca579a45b6
 SHA512:
-  metadata.gz: eaa6b839013fb7af7536e753a561fb18a92dabe287f6c782c1d87033fb2c0a927fca286e5fa9728da88d71fcaa93084ff77e1565f4a6cf06af8f207aa1c0cf86
-  data.tar.gz: a0e156706275fbc0611f3dba7ddc2fa7d6688a06fb5a59ed7e8906defa426576c81a2e9d9dc359eeb9440275ba88d3d24035809a3d4151e600af7e937ba7add1
+  metadata.gz: fc14898bf09f8bbf6f21324bb549708e887a4dc43e132cfe615ef06dc04cfd1f6736566675060aa613d3e6fbecca9017547b247f8c47465bb11979150c25d37e
+  data.tar.gz: da8832650d78644687acebd327c84ee7477f7b9013730af37d5815a7ee31804cb9c53a08fffb951e5ac7b3a39f7a6af4db03867529e2ad062b426b3a44b6daa6

data/.rubocop.yml

@@ -20,4 +20,4 @@ Metrics/LineLength:
   Max: 135
 
 Metrics/ClassLength:
-  Max: 230
+  Max: 250

data/.rubocop_todo.yml

@@ -8,7 +8,7 @@
 
 # Offense count: 16
 Metrics/AbcSize:
-  Max: 49
+  Max: 50
 
 # Offense count: 4
 Metrics/CyclomaticComplexity:
@@ -17,7 +17,7 @@ Metrics/CyclomaticComplexity:
 # Offense count: 21
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 45
+  Max: 48
 
 # Offense count: 2
 Metrics/PerceivedComplexity:

data/CHANGELOG.md

@@ -2,14 +2,38 @@
 
 ## Master
 
-## Master
-### 0.9.0
-* Locales can now update `:code` value
+## 1.0.0
+### Breaking Changes
+* `Client` is no longer a singleton. Therefore all `Resource` class calls (`Entry`, `Space`, `ContentType`, etc...) require an instance of a client.
+  The Client needs to be the first parameter of the call. As sending the client in every call is not a great solution, a shorthand for every resource
+  class is present on the client. Calls can be done now like: `client.entries.all`. This works for every resource class, and all of the calls existing previously
+  (`all`, `find`, `create`, `all_published`). **Note: `all_published` is specific to `Entry`, `Asset` and `ContentType`**.
+* You can have as many instances of client, for as many users as you want.
+
+Complete List of resource links on `Client`:
+* `#entries`
+* `#assets`
+* `#spaces`
+* `#content_types`
+* `#locales`
+* `#webhooks`
+* `#api_keys`
+
+### Fixed
+
+* Removed code duplication between FieldAware and DynamicEntry [#78](https://github.com/contentful/contentful-management.rb/issues/78)
+* Refactored FieldAware code to be simplified
 
+### Added
+
+* Proxy Support [#88](https://github.com/contentful/contentful-management.rb/issues/88)
+
+## 0.9.0
 ### Added
 * Added `#destroy` method to Locales
 * Added `ApiKey` class, methods and `Space` associations
 * Added `.all_published` methods for `ContentType`, `Asset` and `Entry`
+* Locales can now update `:code` value
 
 ### Changed
 * Changed documentation format to YARD

data/README.md

@@ -32,13 +32,13 @@ The access token can easily be created through the [management api documentation
 Retrieving all spaces:
 
 ```ruby
-spaces = Contentful::Management::Space.all
+spaces = client.spaces.all
 ```
 
 Retrieving one space by id:
 
 ```ruby
-blog_space = Contentful::Management::Space.find('blog_space_id')
+blog_space = client.spaces.find('blog_space_id')
 ```
 
 Destroying a space:
@@ -50,7 +50,7 @@ blog_space.destroy
 Creating a space:
 
 ```ruby
-blog_space = Contentful::Management::Space.new
+blog_space = client.spaces.new
 blog_space.name = 'Blog Space'
 blog_space.save
 ```
@@ -58,18 +58,18 @@ blog_space.save
 or
 
 ```ruby
-blog_space = Contentful::Management::Space.create(name: 'Blog Space')
+blog_space = client.spaces.create(name: 'Blog Space')
 ```
 
 or in the context of the organization (if you have multiple organizations within your account):
 
 ```ruby
-blog_space = Contentful::Management::Space.create(name: 'Blog Space', organization_id: 'organization_id')
+blog_space = client.spaces.create(name: 'Blog Space', organization_id: 'organization_id')
 ```
 
 If you want to create a default locale different from `en-US`:
 ```ruby
-blog_space = Contentful::Management::Space.create(name: 'Blog Space', default_locale: 'de-DE')
+blog_space = client.spaces.create(name: 'Blog Space', default_locale: 'de-DE')
 ```
 
 Updating a space:
@@ -608,11 +608,38 @@ This allows for fetching Content Types for your Space at Client instantiation ti
 To enable this, in your Client instantiation do:
 
 ```ruby
-Contentful::Management::Client.new(token, dynamic_entries: ['my_space_id'])
+client = Contentful::Management::Client.new(token, dynamic_entries: ['my_space_id'])
 ```
 
 You can enable the Cache for as many Spaces as you want.
 
+## Proxy Support
+
+This allows for using the CMA SDK through a proxy, for this, your proxy must support HTTPS and your server must have a valid signed certificate.
+
+To enable this, in your Client instantiation do:
+
+```ruby
+PROXY_HOST = 'localhost'
+PROXY_PORT = 8888
+
+# Just Host/Port
+client = Contributing::Management::Client.new(
+  token,
+  proxy_host: PROXY_HOST,
+  proxy_port: PROXY_PORT
+)
+
+# With Username/Password
+client = Contributing::Management::Client.new(
+  token,
+  proxy_host: PROXY_HOST,
+  proxy_port: PROXY_PORT,
+  proxy_username: 'YOUR_USERNAME',
+  proxy_password: 'YOUR_PASSWORD'
+)
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/contentful-management/fork )

data/lib/contentful/management/api_key.rb

@@ -14,51 +14,12 @@ module Contentful
       property :accessToken
       property :policies
 
-      # Gets a collection of api keys.
-      #
-      # @param [String] space_id
-      # @param [Hash] _parameters the parameters for search query
-      # @option _parameters [String] :name The ApiKey name
-      # @option _parameters [String] :description The ApiKey description
-      #
-      # @return [Contentful::Management::Array<Contentful::Management::ApiKey>]
-      def self.all(space_id = nil, _parameters = {})
-        request = Request.new("/#{space_id}/api_keys")
-        response = request.get
-        result = ResourceBuilder.new(response, { 'ApiKey' => ApiKey }, {})
-        result.run
-      end
-
-      # Gets a specific api key.
-      #
-      # @param [String] space_id
-      # @param [String] api_key_id
-      #
-      # @return [Contentful::Management::ApiKey]
-      def self.find(space_id, api_key_id)
-        request = Request.new("/#{space_id}/api_keys/#{api_key_id}")
-        response = request.get
-        result = ResourceBuilder.new(response, { 'ApiKey' => ApiKey }, {})
-        result.run
-      end
-
-      # Creates an api key.
-      #
-      # @param [String] space_id
-      # @param [Hash] attributes
-      # @option attributes [String] :name The ApiKey name
-      # @option attributes [String] :description The ApiKey description
-      #
-      # @return [Contentful::Management::ApiKey]
-      def self.create(space_id, attributes)
-        request = Request.new(
-          "/#{space_id}/api_keys",
+      # @private
+      def self.create_attributes(_client, attributes)
+        {
           'name' => attributes.fetch(:name),
           'description' => attributes.fetch(:description, nil)
-        )
-        response = request.post
-        result = ResourceBuilder.new(response, { 'ApiKey' => ApiKey }, {})
-        result.run
+        }
       end
     end
   end

data/lib/contentful/management/array.rb

@@ -26,8 +26,7 @@ module Contentful
           new_request = request.copy
           new_request.query[:skip] = new_skip
           response = new_request.get
-          result = ResourceBuilder.new(response, {}, {})
-          result.run
+          ResourceBuilder.new(response, client).run
         else
           false
         end

data/lib/contentful/management/asset.rb

@@ -1,6 +1,9 @@
 require_relative 'resource'
 require_relative 'resource/asset_fields'
+require_relative 'resource/all_published'
 require_relative 'resource/fields'
+require_relative 'resource/archiver'
+require_relative 'resource/publisher'
 
 module Contentful
   module Management
@@ -9,80 +12,20 @@ module Contentful
     class Asset
       include Contentful::Management::Resource
       extend Contentful::Management::Resource::AssetFields
+      extend Contentful::Management::Resource::AllPublished
       include Contentful::Management::Resource::Fields
       include Contentful::Management::Resource::SystemProperties
       include Contentful::Management::Resource::Refresher
+      include Contentful::Management::Resource::Archiver
+      include Contentful::Management::Resource::Publisher
 
-      # Gets a collection of assets.
-      #
-      # @param [String] space_id
-      # @param [Hash] query Search Options
-      # @see _ For complete option list: http://docs.contentfulcda.apiary.io/#reference/search-parameters
-      # @option query [String] 'sys.id' Asset ID
-      # @option query [String] :mimetype_group Kind of Asset
-      # @option query [Integer] :limit
-      # @option query [Integer] :skip
-      #
-      # @return [Contentful::Management::Array<Contentful::Management::Asset>]
-      def self.all(space_id, query = {})
-        request = Request.new(
-          "/#{space_id}/assets",
-          query
-        )
-        response = request.get
-        result = ResourceBuilder.new(response, {}, {})
-        result.run
-      end
-
-      # Gets a collection of published assets.
-      #
-      # @param [String] space_id
-      # @param [Hash] query Search Options
-      # @see _ For complete option list: http://docs.contentfulcda.apiary.io/#reference/search-parameters
-      # @option query [String] 'sys.id' Asset ID
-      # @option query [String] :mimetype_group Kind of Asset
-      # @option query [Integer] :limit
-      # @option query [Integer] :skip
-      #
-      # @return [Contentful::Management::Array<Contentful::Management::Asset>]
-      def self.all_published(space_id, query = {})
-        request = Request.new(
-          "/#{space_id}/public/assets",
-          query
-        )
-        response = request.get
-        result = ResourceBuilder.new(response, {}, {})
-        result.run
-      end
-
-      # Gets a specific asset.
-      #
-      # @param [String] space_id
-      # @param [String] asset_id
-      #
-      # @return [Contentful::Management::Asset]
-      def self.find(space_id, asset_id)
-        request = Request.new("/#{space_id}/assets/#{asset_id}")
-        response = request.get
-        result = ResourceBuilder.new(response, {}, {})
-        result.run
+      # @private
+      def self.client_association_class
+        ClientAssetMethodsFactory
       end
 
-      # Creates an asset.
-      #
-      # @param [String] space_id
-      # @param [Hash] attributes
-      # @option attributes [String] :title
-      # @option attributes [String] :description
-      # @option attributes [Contentful::Management::File] :file
-      # @option attributes [String] :locale
-      # @option attributes [Hash] :fields
-      #
-      # @see _ README for more information on how to create an Asset
-      #
-      # @return [Contentful::Management::Asset]
-      def self.create(space_id, attributes)
-        locale = attributes[:locale]
+      # @private
+      def self.create_attributes(client, attributes)
         asset = new
         asset.instance_variable_set(:@fields, attributes[:fields] || {})
         asset.locale = attributes[:locale] || client.default_locale
@@ -90,14 +33,12 @@ module Contentful
         asset.description = attributes[:description] if attributes[:description]
         asset.file = attributes[:file] if attributes[:file]
 
-        request = Request.new(
-          "/#{space_id}/assets/#{attributes[:id]}",
-          fields: asset.fields_for_query
-        )
-        response = attributes[:id].nil? ? request.post : request.put
-        result = ResourceBuilder.new(response, {}, {}).run
-        result.locale = locale if locale
-        result
+        { fields: asset.fields_for_query }
+      end
+
+      # @private
+      def after_create(attributes)
+        self.locale = attributes[:locale] || client.default_locale
       end
 
       # Processing an Asset file
@@ -106,6 +47,7 @@ module Contentful
       def process_file
         instance_variable_get(:@fields).keys.each do |locale|
           request = Request.new(
+            client,
             "/#{space.id}/assets/#{id}/files/#{locale}/process",
             {},
             nil,
@@ -117,32 +59,6 @@ module Contentful
         self
       end
 
-      # Updates an asset.
-      #
-      # @param [Hash] attributes
-      # @option attributes [String] :title
-      # @option attributes [String] :description
-      # @option attributes [Contentful::Management::File] :file
-      # @option attributes [String] :locale
-      #
-      # @see _ README for more information on how to create an Asset
-      #
-      # @return [Contentful::Management::Asset]
-      def update(attributes)
-        self.title = attributes[:title] if attributes[:title]
-        self.description = attributes[:description] if attributes[:description]
-        self.file = attributes[:file] if attributes[:file]
-        request = Request.new(
-          "/#{space.id}/assets/#{id}",
-          { fields: fields_for_query },
-          nil,
-          version: sys[:version]
-        )
-        response = request.put
-        result = ResourceBuilder.new(response, {}, {}).run
-        refresh_data(result)
-      end
-
       # If an asset is a new object gets created in the Contentful, otherwise the existing asset gets updated.
       # @see _ https://github.com/contentful/contentful-management.rb for details.
       #
@@ -151,99 +67,11 @@ module Contentful
         if id
           update(title: title, description: description, file: file)
         else
-          new_instance = self.class.create(sys[:space].id, fields: instance_variable_get(:@fields))
+          new_instance = self.class.create(client, sys[:space].id, fields: instance_variable_get(:@fields))
           refresh_data(new_instance)
         end
       end
 
-      # Destroys an asset.
-      #
-      # @return [true, Contentful::Management::Error] success
-      def destroy
-        request = Request.new("/#{space.id}/assets/#{id}")
-        response = request.delete
-        if response.status == :no_content
-          return true
-        else
-          result = ResourceBuilder.new(response, {}, {})
-          result.run
-        end
-      end
-
-      # Publishes an asset.
-      #
-      # @return [Contentful::Management::Asset]
-      def publish
-        request = Request.new(
-          "/#{space.id}/assets/#{id}/published",
-          {},
-          nil,
-          version: sys[:version]
-        )
-        response = request.put
-        result = ResourceBuilder.new(response, {}, {}).run
-        refresh_data(result)
-      end
-
-      # Unpublishes an asset.
-      #
-      # @return [Contentful::Management::Asset]
-      def unpublish
-        request = Request.new(
-          "/#{space.id}/assets/#{id}/published",
-          {},
-          nil,
-          version: sys[:version]
-        )
-        response = request.delete
-        result = ResourceBuilder.new(response, {}, {}).run
-        refresh_data(result)
-      end
-
-      # Archive an asset.
-      #
-      # @return [Contentful::Management::Asset]
-      def archive
-        request = Request.new(
-          "/#{space.id}/assets/#{id}/archived",
-          {},
-          nil,
-          version: sys[:version]
-        )
-        response = request.put
-        result = ResourceBuilder.new(response, {}, {}).run
-        refresh_data(result)
-      end
-
-      # Unarchvie an asset.
-      #
-      # @return [Contentful::Management::Asset]
-      def unarchive
-        request = Request.new(
-          "/#{space.id}/assets/#{id}/archived",
-          {},
-          nil,
-          version: sys[:version]
-        )
-        response = request.delete
-        result = ResourceBuilder.new(response, {}, {}).run
-        refresh_data(result)
-      end
-
-      # Checks if an asset is published.
-      #
-      # @return [Boolean]
-      def published?
-        sys[:publishedAt] ? true : false
-      end
-
-      # Checks if an asset is archvied.
-      #
-      # @return [Boolean]
-      def archived?
-        sys[:archivedAt] ? true : false
-      end
-
       # Returns currently supported local or default locale.
       # @return [String] current_locale
       def locale
@@ -288,6 +116,16 @@ module Contentful
 
         query.empty? ? file.url : "#{file.url}?#{URI.encode_www_form(query)}"
       end
+
+      protected
+
+      def query_attributes(attributes)
+        self.title = attributes[:title] if attributes[:title]
+        self.description = attributes[:description] if attributes[:description]
+        self.file = attributes[:file] if attributes[:file]
+
+        { fields: fields_for_query }
+      end
     end
   end
 end