contentful-management 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3249dad1b37ff8e203c02f2bb3721b96e111728
-  data.tar.gz: a9b3a74a14feeac1d843f368cff6cdae238c6f70
+  metadata.gz: a5375f7ca984d57cac6d910e9499a7fee451f57f
+  data.tar.gz: 7d847b47c7cb3f9af9dae098f869fb99b4cd04dc
 SHA512:
-  metadata.gz: 109d6ed87ff6e487f96bc2614a790154036af420a88c712a5197c7ba76a0692afa12023f1e2674c895a598e98ee61b25d832c6dfac76bd4039a2711ec659b555
-  data.tar.gz: 54abb173ac94d6f501ea27d5d654fd00063072d29b16a413599e8414e6374ef445613cabdb39ccdbffac9c273f7187c3fa29842f48bc7f8946096e1dd3b65500
+  metadata.gz: 648da2fcb41cb3007f9201e606f460f20b72104b03c6dd57ee5df680d7fca13162b9bfc08018cf4e779d0ff858bc7536d06c8d3a2010239fecab4ff776e93304
+  data.tar.gz: 194e585093ea3025e1b582aa60a96b3d4871afd2030cd9b3cbd5b8b8f29879819d5a7bc56987bfd66adeed95febdd3cb6f188717cb65b920b1b875532f72e53a

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Master
 
+## 1.5.0
+### Added
+* Added support for Select Operator in Entries and Assets
+
 ## 1.4.0
 ### Added
 * Added support for Fallback Locales (`nil` values get now removed from the requests on `#update` and `#create`)

data/contentful-management.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json', '~> 1.8'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake'
+  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'

data/lib/contentful/management/asset.rb

@@ -24,6 +24,11 @@ module Contentful
         ClientAssetMethodsFactory
       end
 
+      # @private
+      def self.pre_process_params(parameters)
+        Support.normalize_select!(parameters)
+      end
+
       # @private
       def self.create_attributes(client, attributes)
         asset = new

data/lib/contentful/management/entry.rb

@@ -24,6 +24,11 @@ module Contentful
 
       attr_accessor :content_type
 
+      # @private
+      def self.pre_process_params(parameters)
+        Support.normalize_select!(parameters)
+      end
+
       # @private
       def self.endpoint
         'entries'

data/lib/contentful/management/resource.rb

@@ -207,6 +207,11 @@ module Contentful
           )
         end
 
+        # @private
+        def pre_process_params(parameters)
+          parameters
+        end
+
         # @private
         def create_attributes(_client, _attributes)
           {}

data/lib/contentful/management/resource_requester.rb

@@ -11,6 +11,7 @@ module Contentful
       end
 
       def all(endpoint_options = {}, query = {})
+        query = resource_class.pre_process_params(query)
         get(endpoint_options, query)
       end
 

data/lib/contentful/management/support.rb

@@ -17,6 +17,17 @@ module Contentful
             oldval.class.to_s == 'Hash' && newval.class.to_s == 'Hash' ? deep_hash_merge(oldval, newval) : newval
           end
         end
+
+        def normalize_select!(parameters)
+          return parameters unless parameters.key?(:select)
+
+          parameters[:select] = parameters[:select].split(',').map(&:strip) if parameters[:select].is_a? String
+          parameters[:select] = parameters[:select].reject { |p| p.start_with?('sys.') }
+          parameters[:select] << 'sys' unless parameters[:select].include?('sys')
+          parameters[:select] = parameters[:select].join(',')
+
+          parameters
+        end
       end
     end
   end

data/lib/contentful/management/version.rb

@@ -3,6 +3,6 @@ module Contentful
   # Management Namespace
   module Management
     # Gem Version
-    VERSION = '1.4.0'
+    VERSION = '1.5.0'
   end
 end

data/spec/fixtures/vcr_cassettes/asset/select_operator.yml

@@ -0,0 +1,137 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/cfexampleapi/assets?select=fields.title,sys&sys.id=nyancat
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - RubyContentfulManagementGem/1.4.0
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Connection:
+      - close
+      Host:
+      - api.contentful.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization,X-Contentful-Skip-Transformation,X-Contentful-User-Agent
+      Access-Control-Allow-Methods:
+      - DELETE,GET,HEAD,POST,PUT,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - Etag
+      Access-Control-Max-Age:
+      - '1728000'
+      Cf-Space-Id:
+      - cfexampleapi
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Date:
+      - Fri, 16 Dec 2016 17:57:18 GMT
+      Etag:
+      - '"b1e04275d327bd92a0b7708469e61e54"'
+      Server:
+      - Contentful
+      Strict-Transport-Security:
+      - max-age=15768000
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Ratelimit-Hour-Limit:
+      - '18000'
+      X-Contentful-Ratelimit-Hour-Remaining:
+      - '17860'
+      X-Contentful-Ratelimit-Reset:
+      - '0'
+      X-Contentful-Ratelimit-Second-Limit:
+      - '10'
+      X-Contentful-Ratelimit-Second-Remaining:
+      - '9'
+      X-Contentful-Request-Id:
+      - fccc4fc0c16dcbc89993ba46ef11722a
+      Content-Length:
+      - '1220'
+      Connection:
+      - Close
+      Set-Cookie:
+      - incap_ses_472_673446=0RSRWi7W0hlhIMcXnuGMBv0qVFgAAAAArAVpzrhH2sNu9g8/gS4xGQ==;
+        path=/; Domain=.contentful.com
+      - nlbi_673446=p9epGdYA1RrEr+hV6lKYhQAAAAAZNLPwoIBxQLcTIy81I+Jj; path=/; Domain=.contentful.com
+      - visid_incap_673446=TKmNQo+PRJamIXAbX/aRVv0qVFgAAAAAQUIPAAAAAABwhsCdHN7togOQgjwxEmlG;
+        expires=Sat, 16 Dec 2017 11:10:55 GMT; path=/; Domain=.contentful.com
+      X-Iinfo:
+      - 8-39954889-39954903 NNNN CT(101 101 0) RT(1481911034611 70) q(0 0 2 -1) r(30
+        30) U5
+      X-Cdn:
+      - Incapsula
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        {
+          "sys": {
+            "type": "Array"
+          },
+          "total": 1,
+          "skip": 0,
+          "limit": 100,
+          "items": [
+            {
+              "fields": {
+                "title": {
+                  "en-US": "Nyan Cat"
+                }
+              },
+              "sys": {
+                "space": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Space",
+                    "id": "cfexampleapi"
+                  }
+                },
+                "id": "nyancat",
+                "type": "Asset",
+                "createdAt": "2013-09-02T14:54:17.868Z",
+                "updatedAt": "2013-09-02T14:56:34.264Z",
+                "createdBy": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "User",
+                    "id": "7BslKh9TdKGOK41VmLDjFZ"
+                  }
+                },
+                "updatedBy": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "User",
+                    "id": "7BslKh9TdKGOK41VmLDjFZ"
+                  }
+                },
+                "publishedCounter": 1,
+                "version": 2,
+                "publishedBy": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "User",
+                    "id": "7BslKh9TdKGOK41VmLDjFZ"
+                  }
+                },
+                "publishedVersion": 1,
+                "firstPublishedAt": "2013-09-02T14:56:34.240Z",
+                "publishedAt": "2013-09-02T14:56:34.240Z"
+              }
+            }
+          ]
+        }
+    http_version: 
+  recorded_at: Fri, 16 Dec 2016 17:57:18 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr_cassettes/entry/select_operator.yml

@@ -0,0 +1,144 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.contentful.com/spaces/cfexampleapi/entries?content_type=cat&select=fields.lives,sys&sys.id=nyancat
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - RubyContentfulManagementGem/1.4.0
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Connection:
+      - close
+      Host:
+      - api.contentful.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization,X-Contentful-Skip-Transformation,X-Contentful-User-Agent
+      Access-Control-Allow-Methods:
+      - DELETE,GET,HEAD,POST,PUT,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - Etag
+      Access-Control-Max-Age:
+      - '1728000'
+      Cf-Space-Id:
+      - cfexampleapi
+      Content-Type:
+      - application/vnd.contentful.management.v1+json
+      Date:
+      - Fri, 16 Dec 2016 18:00:04 GMT
+      Etag:
+      - '"ed0826e81d22bcd08b35f94f4bc82d1e"'
+      Server:
+      - Contentful
+      Strict-Transport-Security:
+      - max-age=15768000
+      X-Content-Type-Options:
+      - nosniff
+      X-Contentful-Ratelimit-Hour-Limit:
+      - '18000'
+      X-Contentful-Ratelimit-Hour-Remaining:
+      - '17883'
+      X-Contentful-Ratelimit-Reset:
+      - '0'
+      X-Contentful-Ratelimit-Second-Limit:
+      - '10'
+      X-Contentful-Ratelimit-Second-Remaining:
+      - '9'
+      X-Contentful-Request-Id:
+      - 28a7082823b538951d9a099bac40c527
+      Content-Length:
+      - '1374'
+      Connection:
+      - Close
+      Set-Cookie:
+      - incap_ses_472_673446=IJw9TuV0ZGKtUsgXnuGMBqMrVFgAAAAAi4iCWS8V/VnXGKNdm/wKyg==;
+        path=/; Domain=.contentful.com
+      - nlbi_673446=ktbvABNwb38Nw5Mv6lKYhQAAAAC4U8Sqbk2yWH0JO+36N3dB; path=/; Domain=.contentful.com
+      - visid_incap_673446=s+iXCCDpTkmJETU1n9MwnqMrVFgAAAAAQUIPAAAAAABRit5PDIa8+j0nzfJqL/e8;
+        expires=Sat, 16 Dec 2017 11:10:55 GMT; path=/; Domain=.contentful.com
+      X-Iinfo:
+      - 8-39995933-39995956 NNNN CT(92 188 0) RT(1481911203237 69) q(0 0 2 -1) r(5
+        5) U5
+      X-Cdn:
+      - Incapsula
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        {
+          "sys": {
+            "type": "Array"
+          },
+          "total": 1,
+          "skip": 0,
+          "limit": 100,
+          "items": [
+            {
+              "fields": {
+                "lives": {
+                  "en-US": 1337
+                }
+              },
+              "sys": {
+                "space": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Space",
+                    "id": "cfexampleapi"
+                  }
+                },
+                "id": "nyancat",
+                "type": "Entry",
+                "createdAt": "2013-06-27T22:46:15.910Z",
+                "updatedAt": "2016-05-19T11:40:57.752Z",
+                "createdBy": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "User",
+                    "id": "7BslKh9TdKGOK41VmLDjFZ"
+                  }
+                },
+                "updatedBy": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "User",
+                    "id": "5NItczv8FWvPn5UTJpTOMM"
+                  }
+                },
+                "publishedCounter": 5,
+                "version": 15,
+                "publishedBy": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "User",
+                    "id": "7BslKh9TdKGOK41VmLDjFZ"
+                  }
+                },
+                "publishedVersion": 10,
+                "firstPublishedAt": "2013-06-27T22:46:19.513Z",
+                "publishedAt": "2013-09-04T09:19:39.027Z",
+                "contentType": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "ContentType",
+                    "id": "cat"
+                  }
+                }
+              }
+            }
+          ]
+        }
+    http_version: 
+  recorded_at: Fri, 16 Dec 2016 18:00:04 GMT
+recorded_with: VCR 3.0.3

data/spec/lib/contentful/management/asset_spec.rb

@@ -34,6 +34,12 @@ module Contentful
             assets.next_page
           end
         end
+        it 'supports select operator' do
+          vcr('asset/select_operator') do
+            nyancat = subject.all('cfexampleapi', 'sys.id' => 'nyancat', select: 'fields.title').first
+            expect(nyancat.fields).to eq({ title: 'Nyan Cat' })
+          end
+        end
       end
 
       describe '.all_published' do

data/spec/lib/contentful/management/entry_spec.rb

@@ -53,6 +53,12 @@ module Contentful
             entries.next_page
           end
         end
+        it 'supports select operator' do
+          vcr('entry/select_operator') do
+            nyancat = subject.all('cfexampleapi', 'sys.id' => 'nyancat', content_type: 'cat', select: 'fields.lives').first
+            expect(nyancat.fields).to eq({lives: 1337})
+          end
+        end
       end
 
       describe '.all_published' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful-management
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Piotr Protas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -72,16 +72,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -305,6 +319,7 @@ files:
 - spec/fixtures/vcr_cassettes/asset/reload.yml
 - spec/fixtures/vcr_cassettes/asset/reload_with_fields.yml
 - spec/fixtures/vcr_cassettes/asset/save_update.yml
+- spec/fixtures/vcr_cassettes/asset/select_operator.yml
 - spec/fixtures/vcr_cassettes/asset/set_locale.yml
 - spec/fixtures/vcr_cassettes/asset/unarchive.yml
 - spec/fixtures/vcr_cassettes/asset/unarchive_already_unarchive.yml
@@ -443,6 +458,7 @@ files:
 - spec/fixtures/vcr_cassettes/entry/search_filter/range_operators_greater_than_or_equal.yml
 - spec/fixtures/vcr_cassettes/entry/search_filter/range_operators_less.yml
 - spec/fixtures/vcr_cassettes/entry/search_filter/reverse_order_sys_updatedAt.yml
+- spec/fixtures/vcr_cassettes/entry/select_operator.yml
 - spec/fixtures/vcr_cassettes/entry/service_unavailable.yml
 - spec/fixtures/vcr_cassettes/entry/too_many_requests.yml
 - spec/fixtures/vcr_cassettes/entry/too_many_requests_retry.yml
@@ -599,6 +615,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/asset/reload.yml
 - spec/fixtures/vcr_cassettes/asset/reload_with_fields.yml
 - spec/fixtures/vcr_cassettes/asset/save_update.yml
+- spec/fixtures/vcr_cassettes/asset/select_operator.yml
 - spec/fixtures/vcr_cassettes/asset/set_locale.yml
 - spec/fixtures/vcr_cassettes/asset/unarchive.yml
 - spec/fixtures/vcr_cassettes/asset/unarchive_already_unarchive.yml
@@ -737,6 +754,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/entry/search_filter/range_operators_greater_than_or_equal.yml
 - spec/fixtures/vcr_cassettes/entry/search_filter/range_operators_less.yml
 - spec/fixtures/vcr_cassettes/entry/search_filter/reverse_order_sys_updatedAt.yml
+- spec/fixtures/vcr_cassettes/entry/select_operator.yml
 - spec/fixtures/vcr_cassettes/entry/service_unavailable.yml
 - spec/fixtures/vcr_cassettes/entry/too_many_requests.yml
 - spec/fixtures/vcr_cassettes/entry/too_many_requests_retry.yml