webflow-ruby 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4c73ca10bddf602a11d63a305e8147cfed9b5472c59d65a153844a3302bce45
-  data.tar.gz: a72c6ba8f56a4a1e0f2e9541673865569aec4baa8c11cf840f44f0088def8fb8
+  metadata.gz: 86911a03c1684d161e4308f07197af038ebdb175369b1c75e1d62eaf9143de4a
+  data.tar.gz: 9df52553d7211783fdd1145a90dbbcec7dbaf398435a516eff8ba5c0990cd11f
 SHA512:
-  metadata.gz: f2b7e05783dfb5205b4916519764e0a94eb8a4ca859095a423a8a4b07757d721a526a16f1aae92a484110b9377ce92fac169d523c9949159b0f26cb1064e3251
-  data.tar.gz: 3b3746a6da9a951111aff2cacc3dca8fa90291a378ba765445982b4d20c913c6b540a1a74e119dce9b5ded593e58a4de575f06affb83ad1d35983b8c56486000
+  metadata.gz: '081549aad5ce13361cca07e0537263493484d7de30383697ec6d0185754c7f2c4215bcfe1ff00b444aa3e46edc957ad61942cf34265fcf3653b65d675e976c45'
+  data.tar.gz: 433cf0bf095bc151b342738bef6bc6373286fda23a6688e3ae72e6b690e569249731dc74af4d9f37b0c6db2c6d8bf7fefb29799808ec3917e416244c06ddae5d

data/.gitignore

@@ -7,3 +7,5 @@
 /spec/reports/
 /tmp/
 *.gem
+*.swo
+*.swp

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.0
+
+* [BREAKING] Raise errors when status > 200, see also https://github.com/penseo/webflow-ruby/pull/7 😍 @sega
+
 ## 0.7.0
 
 * [FEATURE] Configuration class to store api token https://github.com/penseo/webflow-ruby/pull/6 😍 @mateuscruz

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    webflow-ruby (0.7.0)
+    webflow-ruby (1.0.0)
       http
 
 GEM

data/README.md

@@ -28,9 +28,8 @@ Have a look at the tests, seriously!
 
 ## Todo
 
-* Error handling, it's all JSON for now
 * Resource mapping, it's plain hashes for now
-* Proper docs
+* Proper docs (please look at the tests for now)
 
 ## Contributing
 

data/lib/webflow/client.rb

@@ -119,30 +119,17 @@ module Webflow
 
       response = HTTP.auth(bearer).headers(headers).request(method, url, params: params, json: data)
 
-      rate_limit = response.headers.select { |key, value| key =~ /X-Ratelimit/ }.to_h
-      @rate_limit = rate_limit unless rate_limit.empty?
+      track_rate_limit(response.headers)
 
-      JSON.parse(response.body)
-    end
+      result = JSON.parse(response.body)
+      raise Webflow::Error.new(result) if response.code >= 400
 
-    def track_rate_limit(headers)
+      result
     end
 
-    # https://developers.webflow.com/#errors
-    def self.error_codes
-      {
-        [400,	SyntaxError] =>	'Request body was incorrectly formatted. Likely invalid JSON being sent up.',
-        [400,	InvalidAPIVersion] =>	'Requested an invalid API version',
-        [400,	UnsupportedVersion] =>	'Requested an API version that in unsupported by the requested route',
-        [400,	NotImplemented] =>	'This feature is not currently implemented',
-        [400,	ValidationError] =>	'Validation failure (see err field in the response)',
-        [400,	Conflict] =>	'Request has a conflict with existing data.',
-        [401,	Unauthorized] =>	'Provided access token is invalid or does not have access to requested resource',
-        [404,	NotFound] =>	'Requested resource not found',
-        [429,	RateLimit] =>	'The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.',
-        [500,	ServerError] =>	'We had a problem with our server. Try again later.',
-        [400,	UnknownError] =>	'An error occurred which is not enumerated here, but is not a server error.',
-      }
+    def track_rate_limit(headers)
+      rate_limit = headers.select { |key, value| key =~ /X-Ratelimit/ }.to_h
+      @rate_limit = rate_limit unless rate_limit.empty?
     end
   end
 end

data/lib/webflow/error.rb

@@ -0,0 +1,34 @@
+module Webflow
+  class Error < StandardError
+    # https://developers.webflow.com/#errors
+    # 400 	SyntaxError 	Request body was incorrectly formatted. Likely invalid JSON being sent up.
+    # 400 	InvalidAPIVersion 	Requested an invalid API version
+    # 400 	UnsupportedVersion 	Requested an API version that in unsupported by the requested route
+    # 400 	NotImplemented 	This feature is not currently implemented
+    # 400 	ValidationError 	Validation failure (see problems field in the response)
+    # 400 	Conflict 	Request has a conflict with existing data.
+    # 401 	Unauthorized 	Provided access token is invalid or does not have access to requested resource
+    # 404 	NotFound 	Requested resource not found
+    # 429 	RateLimit 	The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.
+    # 500 	ServerError 	We had a problem with our server. Try again later.
+    # 400 	UnknownError 	An error occurred which is not enumerated here, but is not a server error.
+    #
+    # Sample error response
+    #
+    # {
+    #   "msg": "Cannot access resource",
+    #   "code": 401,
+    #   "name": "Unauthorized",
+    #   "path": "/sites/invalid_site",
+    #   "err": "Unauthorized: Cannot access resource"
+    # }
+
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+
+      super(data['msg'])
+    end
+  end
+end

data/lib/webflow/ruby.rb

@@ -1,3 +1,4 @@
 require 'webflow/version'
 require 'webflow/config'
 require 'webflow/client'
+require 'webflow/error'

data/lib/webflow/version.rb

@@ -1,3 +1,3 @@
 module Webflow
-  VERSION = "0.7.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webflow-ruby
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - phoet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-30 00:00:00.000000000 Z
+date: 2019-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -131,6 +131,7 @@ files:
 - lib/webflow.rb
 - lib/webflow/client.rb
 - lib/webflow/config.rb
+- lib/webflow/error.rb
 - lib/webflow/ruby.rb
 - lib/webflow/version.rb
 - webflow.gemspec