contentful 2.1.3 → 2.2.0

data/lib/contentful/support.rb

@@ -5,9 +5,12 @@ module Contentful
       # Transforms CamelCase into snake_case (taken from zucker)
       #
       # @param [String] object camelCaseName
+      # @param [Boolean] skip if true, skips returns original object
       #
       # @return [String] snake_case_name
-      def snakify(object)
+      def snakify(object, skip = false)
+        return object if skip
+
         String(object)
           .gsub(/::/, '/')
           .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')

data/lib/contentful/version.rb

@@ -1,5 +1,5 @@
 # Contentful Namespace
 module Contentful
   # Gem Version
-  VERSION = '2.1.3'
+  VERSION = '2.2.0'
 end

data/spec/asset_spec.rb

@@ -156,4 +156,13 @@ describe Contentful::Asset do
       }
     end
   end
+
+  describe 'camelCase' do
+    it 'properties now are accessed with camelcase' do
+      vcr('asset') {
+        asset = create_client(use_camel_case: true).asset('nyancat')
+        expect(asset.file.fileName).to eq 'Nyan_cat_250px_frame.png'
+      }
+    end
+  end
 end

data/spec/content_type_spec.rb

@@ -36,4 +36,14 @@ describe Contentful::ContentType do
       expect(content_type).to respond_to :display_field
     end
   end
+
+  describe 'camel case' do
+    it 'supports camel case' do
+      vcr('content_type') {
+        content_type = create_client(use_camel_case: true).content_type 'cat'
+
+        expect(content_type.displayField).to eq 'name'
+      }
+    end
+  end
 end

data/spec/deleted_asset_spec.rb

@@ -25,4 +25,14 @@ describe 'DeletedAsset' do
       expect(deleted_asset.created_at).to be_a DateTime
     end
   end
+
+  describe 'camel case' do
+    it 'supports camel case' do
+      vcr('sync_deleted_asset') {
+        deleted_asset = create_client(use_camel_case: true).sync(initial: true, type: 'DeletedAsset').first_page.items[0]
+
+        expect(deleted_asset.createdAt).to be_a DateTime
+      }
+    end
+  end
 end

data/spec/deleted_entry_spec.rb

@@ -25,4 +25,14 @@ describe 'DeletedEntry' do
       expect(deleted_entry.created_at).to be_a DateTime
     end
   end
+
+  describe 'camel case' do
+    it 'supports camel case' do
+      vcr('sync_deleted_entry') {
+        deleted_entry = create_client(use_camel_case: true).sync(initial: true, type: 'DeletedEntry').first_page.items[0]
+
+        expect(deleted_entry.createdAt).to be_a DateTime
+      }
+    end
+  end
 end

data/spec/entry_spec.rb

@@ -358,4 +358,15 @@ describe Contentful::Entry do
       }
     end
   end
+
+  describe 'camel case' do
+    it 'supports camel case' do
+      vcr('entry') {
+        entry = create_client(use_camel_case: true).entry 'nyancat'
+
+        expect(entry.bestFriend.name).to eq 'Happy Cat'
+        expect(entry.createdAt).to be_a DateTime
+      }
+    end
+  end
 end

data/spec/error_class_spec.rb

@@ -11,9 +11,251 @@ describe Contentful::Error do
 
   describe '#message' do
     it 'returns the message found in the response json' do
+      message = "HTTP status code: 404\n"\
+                "Message: The resource could not be found.\n"\
+                "Details: {\"type\"=>\"Entry\", \"space\"=>\"cfexampleapi\", \"id\"=>\"not found\"}\n"\
+                "Request ID: 85f-351076632"
       expect(Contentful::Error.new(r).message).not_to be_nil
-      expect(Contentful::Error.new(r).message).to \
-          eq json_fixture('not_found')['message']
+      expect(Contentful::Error.new(r).message).to eq message
+    end
+
+    describe 'message types' do
+      describe 'default messages' do
+        it '400' do
+          response = Contentful::Response.new raw_fixture('default_400', 400)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 400\n"\
+                    "Message: The request was malformed or missing a required parameter.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '401' do
+          response = Contentful::Response.new raw_fixture('default_401', 401)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 401\n"\
+                    "Message: The authorization token was invalid.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '403' do
+          response = Contentful::Response.new raw_fixture('default_403', 403)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 403\n"\
+                    "Message: The specified token does not have access to the requested resource.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '404' do
+          response = Contentful::Response.new raw_fixture('default_404', 404)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 404\n"\
+                    "Message: The requested resource or endpoint could not be found.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '429' do
+          response = Contentful::Response.new raw_fixture('default_429', 429)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 429\n"\
+                    "Message: Rate limit exceeded. Too many requests.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '500' do
+          response = Contentful::Response.new raw_fixture('default_500', 500)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 500\n"\
+                    "Message: Internal server error.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '502' do
+          response = Contentful::Response.new raw_fixture('default_502', 502)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 502\n"\
+                    "Message: The requested space is hibernated.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '503' do
+          response = Contentful::Response.new raw_fixture('default_503', 503)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 503\n"\
+                    "Message: The request was malformed or missing a required parameter.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+      end
+
+      describe 'special cases' do
+        describe '400' do
+          it 'details is a string' do
+            response = Contentful::Response.new raw_fixture('400_details_string', 400)
+            error = Contentful::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 400\n"\
+                      "Message: The request was malformed or missing a required parameter.\n"\
+                      "Details: some error\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+
+          it 'details is an object, internal errors are strings' do
+            response = Contentful::Response.new raw_fixture('400_details_errors_string', 400)
+            error = Contentful::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 400\n"\
+                      "Message: The request was malformed or missing a required parameter.\n"\
+                      "Details: some error\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+
+          it 'details is an object, internal errors are objects which have details' do
+            response = Contentful::Response.new raw_fixture('400_details_errors_object', 400)
+            error = Contentful::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 400\n"\
+                      "Message: The request was malformed or missing a required parameter.\n"\
+                      "Details: some error\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+        end
+
+        describe '403' do
+          it 'has an array of reasons' do
+            response = Contentful::Response.new raw_fixture('403_reasons', 403)
+            error = Contentful::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 403\n"\
+                      "Message: The specified token does not have access to the requested resource.\n"\
+                      "Details: \n\tReasons:\n"\
+                      "\t\tfoo\n"\
+                      "\t\tbar\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+        end
+
+        describe '404' do
+          it 'has a type' do
+            response = Contentful::Response.new raw_fixture('404_type', 404)
+            error = Contentful::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 404\n"\
+                      "Message: The requested resource or endpoint could not be found.\n"\
+                      "Details: The requested Asset could not be found.\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+
+          it 'can specify the resource id' do
+            response = Contentful::Response.new raw_fixture('404_id', 404)
+            error = Contentful::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 404\n"\
+                      "Message: The requested resource or endpoint could not be found.\n"\
+                      "Details: The requested Asset could not be found. ID: foobar.\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+        end
+
+        describe '429' do
+          it 'can show the time until reset' do
+            response = Contentful::Response.new raw_fixture('default_429', 429, false, {'x-contentful-ratelimit-reset' => 60})
+            error = Contentful::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 429\n"\
+                      "Message: Rate limit exceeded. Too many requests.\n"\
+                      "Request ID: 85f-351076632\n"\
+                      "Time until reset (seconds): 60"
+            expect(error.message).to eq message
+          end
+        end
+      end
+
+      describe 'generic error' do
+        it 'with everything' do
+          response = Contentful::Response.new raw_fixture('other_error', 512)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 512\n"\
+                    "Message: Some error occurred.\n"\
+                    "Details: some text\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it 'no details' do
+          response = Contentful::Response.new raw_fixture('other_error_no_details', 512)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 512\n"\
+                    "Message: Some error occurred.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it 'no request id' do
+          response = Contentful::Response.new raw_fixture('other_error_no_request_id', 512)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 512\n"\
+                    "Message: Some error occurred.\n"\
+                    "Details: some text"
+          expect(error.message).to eq message
+        end
+
+        it 'no message' do
+          response = Contentful::Response.new raw_fixture('other_error_no_message', 512)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 512\n"\
+                    "Message: The following error was received: {\n"\
+                    "  \"sys\": {\n"\
+                    "    \"type\": \"Error\",\n"\
+                    "    \"id\": \"SomeError\"\n"\
+                    "  },\n"\
+                    "  \"details\": \"some text\",\n"\
+                    "  \"requestId\": \"85f-351076632\"\n"\
+                    "}\n"\
+                    "\n"\
+                    "Details: some text\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it 'nothing' do
+          response = Contentful::Response.new raw_fixture('other_error_nothing', 512)
+          error = Contentful::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 512\n"\
+                    "Message: The following error was received: {\n"\
+                    "  \"sys\": {\n"\
+                    "    \"type\": \"Error\",\n"\
+                    "    \"id\": \"SomeError\"\n"\
+                    "  }\n"\
+                    "}\n"
+          expect(error.message).to eq message
+        end
+      end
     end
   end
 
@@ -28,7 +270,6 @@ describe Contentful::Error do
   end
 
   describe '.[]' do
-
     it 'returns BadRequest error class for 400' do
       expect(Contentful::Error[400]).to eq Contentful::BadRequest
     end

data/spec/field_spec.rb

@@ -58,4 +58,25 @@ describe Contentful::Field do
       expect(arrayField.items.link_type).to eq 'Entry'
     end
   end
+
+  describe 'issues' do
+    describe 'json field' do
+      it 'can coerce properly when top level is not object' do
+        coercion = Contentful::ObjectCoercion.new([{foo: 123}])
+        expect(coercion.coerce).to eq [{foo: 123}]
+
+        coercion = Contentful::ObjectCoercion.new('foobar')
+        expect(coercion.coerce).to eq 'foobar'
+
+        coercion = Contentful::ObjectCoercion.new(true)
+        expect(coercion.coerce).to eq true
+
+        coercion = Contentful::ObjectCoercion.new(123)
+        expect(coercion.coerce).to eq 123
+
+        coercion = Contentful::ObjectCoercion.new({foo: 123})
+        expect(coercion.coerce).to eq(foo: 123)
+      end
+    end
+  end
 end

data/spec/file_spec.rb

@@ -20,4 +20,14 @@ describe Contentful::File do
       expect(file.details).to be_instance_of Hash
     end
   end
+
+  describe 'camel case' do
+    it 'supports camel case' do
+      vcr('asset') {
+        file = create_client(use_camel_case: true).asset('nyancat').file
+        expect(file.contentType).to eq 'image/png'
+        expect(file.fileName).to eq 'Nyan_cat_250px_frame.png'
+      }
+    end
+  end
 end

data/spec/fixtures/json_responses/400_details_errors_object.json

@@ -0,0 +1,14 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "BadRequest"
+  },
+  "details": {
+    "errors": [
+        {
+            "details": "some error"
+        }
+    ]
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/400_details_errors_string.json

@@ -0,0 +1,12 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "BadRequest"
+  },
+  "details": {
+    "errors": [
+      "some error"
+    ]
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/400_details_string.json

@@ -0,0 +1,8 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "BadRequest"
+  },
+  "details": "some error",
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/403_reasons.json

@@ -0,0 +1,13 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "AccessDenied"
+  },
+  "details": {
+    "reasons": [
+        "foo",
+        "bar"
+    ]
+  },
+  "requestId": "85f-351076632"
+}