contentful-management 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42f0a71eab4ad41c748aebb12abdcf07b5a28b49
-  data.tar.gz: e8c7b508d8dfd513d14ea65e9ff41cb0d6764a2c
+  metadata.gz: 7374c6a0e9550339b72a54bc9e834b7f3bca3a8a
+  data.tar.gz: 058292ffa85f933dc083712cd918cdd91ecea921
 SHA512:
-  metadata.gz: afe225415231cfe9df74f92b9b8489379b273d0ed88d5e263d6cb5bb28a842c237f81cb39f92b9ccfbcc43de5f566db1c74a3cb37c5c90240001278d5f2f7bcf
-  data.tar.gz: 91405326650913dd79f0fd85485c67503bedbbb8c16fd13a108b8395d26073cf5bb14de90a1d374735de3894dab0b8807c2f9b4fef98b28b43ff2f99bdd1ece3
+  metadata.gz: eaa6b839013fb7af7536e753a561fb18a92dabe287f6c782c1d87033fb2c0a927fca286e5fa9728da88d71fcaa93084ff77e1565f4a6cf06af8f207aa1c0cf86
+  data.tar.gz: a0e156706275fbc0611f3dba7ddc2fa7d6688a06fb5a59ed7e8906defa426576c81a2e9d9dc359eeb9440275ba88d3d24035809a3d4151e600af7e937ba7add1

data/.rubocop.yml

@@ -1,40 +1,23 @@
-Encoding:
-  Enabled: false
+inherit_from: .rubocop_todo.yml
 
-Documentation:
+Encoding:
   Enabled: false
 
-ClassLength:
-  Enabled: false
+Metrics/ClassLength:
+  CountComments: false
 
 AllCops:
   Exclude:
     - contentful-management.gemspec
     - bin/cma-console
+    - spec/**/*
+    - examples/**/*
+    - Guardfile
+    - Gemfile
+    - Rakefile
 
-LineLength:
+Metrics/LineLength:
   Max: 135
-Style/MethodLength:
-  Max: 15
-
-Style/SpaceInsideBrackets:
-  Enabled: false
-
-Style/CyclomaticComplexity:
-  Max: 8
-
-Style/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-  EnforcedStyleForEmptyBraces: no_space
-
-Style/CaseIndentation:
-  Enabled: false
-
-Lint/UselessAssignment:
-  Enabled: false
-
-Style/IndentationWidth:
-  Enabled: false
 
-Style/GuardClause:
-  Enabled: false
+Metrics/ClassLength:
+  Max: 230

data/.rubocop_todo.yml

@@ -0,0 +1,24 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-02-01 08:50:00 -0300 using RuboCop version 0.34.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 16
+Metrics/AbcSize:
+  Max: 49
+
+# Offense count: 4
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 21
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 45
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 8

data/.travis.yml

@@ -8,7 +8,7 @@ rvm:
   - jruby-19mode
 
 before_install: gem install bundler -v 1.10.6
-script: bundle exec rake spec
+script: bundle exec rake rspec_rubocop
 notifications:
   slack:
     secure: P+BWOt+sKPUlIwxUMaD7o4bVG19nIsedyv9D1MCBJELKxTYkXOyJECSNw1f5SDf9z0n4lKhfp8SY0dVigvxdUBd9/wsGqRZMMI2sykDJ8E85cYsUb8corEnIgQtwwzkAzWzhCbmWrZe39ai1Sr5ET/7bdEJ7SXIKbFS350SOn9s=

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Master
 
+## Master
+### 0.9.0
+* Locales can now update `:code` value
+
+### Added
+* Added `#destroy` method to Locales
+* Added `ApiKey` class, methods and `Space` associations
+* Added `.all_published` methods for `ContentType`, `Asset` and `Entry`
+
+### Changed
+* Changed documentation format to YARD
+
 ## 0.8.0
 ### Added
 * Added `:dynamic_entries` parameter on Client initialization

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 group :development do
   gem 'guard'
   gem 'guard-rspec'
+  gem 'guard-rubocop'
   gem 'pry'
 end
 

data/Guardfile

@@ -24,47 +24,52 @@
 #  * zeus: 'zeus rspec' (requires the server to be started separately)
 #  * 'just' rspec: 'rspec'
 
-guard :rspec, cmd: "bundle exec rspec --format documentation" do
-  require "guard/rspec/dsl"
-  dsl = Guard::RSpec::Dsl.new(self)
+group :green_red_refactor, halt_on_fail: true do
+  guard :rspec, cmd: "bundle exec rspec --format documentation" do
+    require "guard/rspec/dsl"
+    dsl = Guard::RSpec::Dsl.new(self)
 
-  # Feel free to open issues for suggestions and improvements
+    # Feel free to open issues for suggestions and improvements
 
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
 
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
+    # 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)
+    # 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
+    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" }
 
-  # 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]}") }
 
-  # 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
 
-  # 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"
+  guard :rubocop, cmd: "rubocop" do
   end
 end

data/README.md

@@ -93,6 +93,12 @@ Retrieving all content types from a space:
 blog_post_content_types = blog_space.content_types.all
 ```
 
+Retrieving all published content types from a space:
+
+```ruby
+blog_post_content_types = blog_space.content_types.all_published
+```
+
 Retrieving one content type by id from a space:
 
 ```ruby
@@ -199,15 +205,25 @@ Updating a locale
 blog_post_locale.update(name: 'German', code: 'de-DE')
 ```
 
+Destroying a locale
+```ruby
+blog_post_locale.destroy
+```
+
 ### Assets
 
 Retrieving all assets from the space:
 
-
 ```ruby
 blog_post_assets = blog_space.assets.all
 ```
 
+Retrieving all published assets from the space:
+
+```ruby
+blog_post_assets = blog_space.assets.all_published
+```
+
 Retrieving an asset by id:
 
 ```ruby
@@ -314,6 +330,12 @@ Retrieving all entries from the space:
 entries = blog_space.entries.all
 ```
 
+Retrieving all published entries from the space:
+
+```ruby
+entries = blog_space.entries.all_published
+```
+
 Retrieving all entries from the space with given content type:
 
 ```ruby
@@ -444,6 +466,25 @@ Destroying webhook:
 blog_post_webhook.destroy
 ```
 
+### Api Keys
+
+Retrieving all api keys from the space:
+
+```ruby
+blog_post_api_keys = blog_space.api_keys.all
+```
+
+Retrieving one api key by the api-key-id from the space:
+
+```ruby
+blog_post_api_key = blog_space.api_keys.find(api_key_id)
+```
+
+Creating an api key
+```ruby
+blog_space.api_keys.create(name: 'foobar key', description: 'key for foobar mobile app')
+```
+
 ## Validations
 
 #### in

data/Rakefile

@@ -32,5 +32,7 @@ end
 desc 'Run specs, rubocop and reek'
 task ci: %w(spec reek rubocop)
 
+task rspec_rubocop: %w(spec rubocop)
+
 task test: :spec
 task default: :spec

data/contentful-management.gemspec

@@ -26,7 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rspec-its'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'reek', '~> 2', '>= 2.0.4'
+  spec.add_development_dependency 'reek', '~> 2.2.1'
+  spec.add_development_dependency 'unparser', '0.2.4'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock', '~> 1', '>= 1.17.3'
 end

data/lib/contentful/management/api_key.rb

@@ -0,0 +1,65 @@
+require_relative 'resource'
+
+module Contentful
+  module Management
+    # Resource class for ApiKey.
+    # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/api-keys
+    class ApiKey
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      property :name
+      property :description
+      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",
+          'name' => attributes.fetch(:name),
+          'description' => attributes.fetch(:description, nil)
+        )
+        response = request.post
+        result = ResourceBuilder.new(response, { 'ApiKey' => ApiKey }, {})
+        result.run
+      end
+    end
+  end
+end

data/lib/contentful/management/array.rb

@@ -4,9 +4,10 @@ require_relative 'resource/array_like'
 module Contentful
   module Management
     # Resource Class for Arrays (e.g. search results)
-    # https://www.contentful.com/developers/documentation/content-delivery-api/#arrays
-    # It also provides an #each method and includes Ruby's Enumerable module (gives you methods like #min, #first, etc)
+    # @see _ https://www.contentful.com/developers/documentation/content-delivery-api/#arrays
+    # @note It also provides an #each method and includes Ruby's Enumerable module (gives you methods like #min, #first, etc)
     class Array
+      # @private
       DEFAULT_LIMIT = 100
 
       include Contentful::Management::Resource

data/lib/contentful/management/asset.rb

@@ -5,7 +5,7 @@ require_relative 'resource/fields'
 module Contentful
   module Management
     # Resource class for Asset.
-    # https://www.contentful.com/developers/documentation/content-management-api/#resources-assets
+    # @see _ https://www.contentful.com/developers/documentation/content-management-api/#resources-assets
     class Asset
       include Contentful::Management::Resource
       extend Contentful::Management::Resource::AssetFields
@@ -14,12 +14,41 @@ module Contentful
       include Contentful::Management::Resource::Refresher
 
       # Gets a collection of assets.
-      # Takes an id of space and an optional hash of query options
-      # Returns a Contentful::Management::Array of Contentful::Management::Asset.
+      #
+      # @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
+          "/#{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, {}, {})
@@ -27,18 +56,31 @@ module Contentful
       end
 
       # Gets a specific asset.
-      # Takes an id of space and asset.
-      # Returns a Contentful::Management::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 }")
+        request = Request.new("/#{space_id}/assets/#{asset_id}")
         response = request.get
         result = ResourceBuilder.new(response, {}, {})
         result.run
       end
 
       # Creates an asset.
-      # Takes a space id and hash with attributes (title, description, file)
-      # Returns a Contentful::Management::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]
         asset = new
@@ -49,8 +91,8 @@ module Contentful
         asset.file = attributes[:file] if attributes[:file]
 
         request = Request.new(
-            "/#{ space_id }/assets/#{ attributes[:id]}",
-            fields: asset.fields_for_query
+          "/#{space_id}/assets/#{attributes[:id]}",
+          fields: asset.fields_for_query
         )
         response = attributes[:id].nil? ? request.post : request.put
         result = ResourceBuilder.new(response, {}, {}).run
@@ -59,13 +101,15 @@ module Contentful
       end
 
       # Processing an Asset file
+      #
+      # @return [Contentful::Management::Asset]
       def process_file
         instance_variable_get(:@fields).keys.each do |locale|
           request = Request.new(
-              "/#{ space.id }/assets/#{ id }/files/#{ locale }/process",
-              {},
-              id = nil,
-              version: sys[:version]
+            "/#{space.id}/assets/#{id}/files/#{locale}/process",
+            {},
+            nil,
+            version: sys[:version]
           )
           request.put
         end
@@ -74,17 +118,25 @@ module Contentful
       end
 
       # Updates an asset.
-      # Takes hash with attributes (title, description, file)
-      # Returns a Contentful::Management::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},
-            id = nil,
-            version: sys[:version]
+          "/#{space.id}/assets/#{id}",
+          { fields: fields_for_query },
+          nil,
+          version: sys[:version]
         )
         response = request.put
         result = ResourceBuilder.new(response, {}, {}).run
@@ -92,7 +144,9 @@ module Contentful
       end
 
       # If an asset is a new object gets created in the Contentful, otherwise the existing asset gets updated.
-      # See README for details.
+      # @see _ https://github.com/contentful/contentful-management.rb for details.
+      #
+      # @return [Contentful::Management::Asset]
       def save
         if id
           update(title: title, description: description, file: file)
@@ -103,9 +157,10 @@ module Contentful
       end
 
       # Destroys an asset.
-      # Returns true if succeed.
+      #
+      # @return [true, Contentful::Management::Error] success
       def destroy
-        request = Request.new("/#{ space.id }/assets/#{ id }")
+        request = Request.new("/#{space.id}/assets/#{id}")
         response = request.delete
         if response.status == :no_content
           return true
@@ -116,13 +171,14 @@ module Contentful
       end
 
       # Publishes an asset.
-      # Returns a Contentful::Management::Asset.
+      #
+      # @return [Contentful::Management::Asset]
       def publish
         request = Request.new(
-            "/#{ space.id }/assets/#{ id }/published",
-            {},
-            id = nil,
-            version: sys[:version]
+          "/#{space.id}/assets/#{id}/published",
+          {},
+          nil,
+          version: sys[:version]
         )
         response = request.put
         result = ResourceBuilder.new(response, {}, {}).run
@@ -130,13 +186,14 @@ module Contentful
       end
 
       # Unpublishes an asset.
-      # Returns a Contentful::Management::Asset.
+      #
+      # @return [Contentful::Management::Asset]
       def unpublish
         request = Request.new(
-            "/#{ space.id }/assets/#{ id }/published",
-            {},
-            id = nil,
-            version: sys[:version]
+          "/#{space.id}/assets/#{id}/published",
+          {},
+          nil,
+          version: sys[:version]
         )
         response = request.delete
         result = ResourceBuilder.new(response, {}, {}).run
@@ -144,13 +201,14 @@ module Contentful
       end
 
       # Archive an asset.
-      # Returns a Contentful::Management::Asset.
+      #
+      # @return [Contentful::Management::Asset]
       def archive
         request = Request.new(
-            "/#{ space.id }/assets/#{ id }/archived",
-            {},
-            id = nil,
-            version: sys[:version]
+          "/#{space.id}/assets/#{id}/archived",
+          {},
+          nil,
+          version: sys[:version]
         )
         response = request.put
         result = ResourceBuilder.new(response, {}, {}).run
@@ -158,13 +216,14 @@ module Contentful
       end
 
       # Unarchvie an asset.
-      # Returns a Contentful::Management::Asset.
+      #
+      # @return [Contentful::Management::Asset]
       def unarchive
         request = Request.new(
-            "/#{ space.id }/assets/#{ id }/archived",
-            {},
-            id = nil,
-            version: sys[:version]
+          "/#{space.id}/assets/#{id}/archived",
+          {},
+          nil,
+          version: sys[:version]
         )
         response = request.delete
         result = ResourceBuilder.new(response, {}, {}).run
@@ -172,18 +231,21 @@ module Contentful
       end
 
       # Checks if an asset is published.
-      # Returns true if published.
+      #
+      # @return [Boolean]
       def published?
         sys[:publishedAt] ? true : false
       end
 
       # Checks if an asset is archvied.
-      # Returns true if archived.
+      #
+      # @return [Boolean]
       def archived?
         sys[:archivedAt] ? true : false
       end
 
       # Returns currently supported local or default locale.
+      # @return [String] current_locale
       def locale
         sys && sys[:locale] ? sys[:locale] : default_locale
       end
@@ -197,6 +259,7 @@ module Contentful
         end
       end
 
+      # @private
       def get_value_from(fields, field_name)
         if field_name == :file
           fields[field_name].properties if fields[field_name]
@@ -205,19 +268,22 @@ module Contentful
         end
       end
 
-      # Returns the image url of an asset
-      # Allows you to pass in the following options for image resizing:
-      #   :width
-      #   :height
-      #   :format
-      #   :quality
-      # See https://www.contentful.com/developers/documentation/content-delivery-api/#image-asset-resizing
+      # Generates a URL for the Contentful Image API
+      #
+      # @param [Hash] options
+      # @option options [Integer] :width
+      # @option options [Integer] :height
+      # @option options [String] :format
+      # @option options [String] :quality
+      # @see _ https://www.contentful.com/developers/documentation/content-delivery-api/#image-asset-resizing
+      #
+      # @return [String] Image API URL
       def image_url(options = {})
         query = {
-            w: options[:w] || options[:width],
-            h: options[:h] || options[:height],
-            fm: options[:fm] || options[:format],
-            q: options[:q] || options[:quality]
+          w: options[:w] || options[:width],
+          h: options[:h] || options[:height],
+          fm: options[:fm] || options[:format],
+          q: options[:q] || options[:quality]
         }.select { |_k, value| value }
 
         query.empty? ? file.url : "#{file.url}?#{URI.encode_www_form(query)}"