webflow-ruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 795515e4a0541b3666b88ebfc14b0c9d0320bd24
-  data.tar.gz: bd901ecbbeefa64aeb9923c85ed1544f0acd6288
+  metadata.gz: 2df995b45bc57f7941d8fae264b58e29593d69d3
+  data.tar.gz: 25abadb527e7ae8360da648bf5f55ed174f67b9d
 SHA512:
-  metadata.gz: 0ce4d22046993fd651aac252a325255663cb7b7b70f845e1609063b6f0a18778d0c2a6126859c5eca7c03ab59f85ee1f2f9b44156c9d3e520a548237562e092c
-  data.tar.gz: aab0bd815df76b7c154448bd77236f3e61861417697a9e2dfe040f4865fc0454b86855d73dd32d2e9af20f40cf30be2d2873bf7530c189d4a3c2446a3a78abf6
+  metadata.gz: a72d46c3803b36dc9484a15b2bad0a6b2304d036c74ccc00a90e5b680a7306afe21ca9fc7da4f7adeb2fe293501763ba349c0fd436b572d6f6592fce3a70539b
+  data.tar.gz: 8193ed9ec0fba4bd6ca28f67e9d5860b7ed73ec9c982ef5b155da0929b96fa901fa1d0d4c6382c0b4aa2a3887db4531c56759147b71860b031d4b8e61906ac81

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in webflow.gemspec
 gemspec
-
-gem 'byebug'

data/lib/webflow/client.rb

@@ -5,9 +5,19 @@ require 'oj'
 module Webflow
   class Client
     HOST = 'https://api.webflow.com'
+    OJ_OPTIONS = {mode: :strict, nilnil: true}
 
     def initialize(token)
       @token = token
+      @rate_limit = {}
+    end
+
+    def rate_limit
+      @rate_limit
+    end
+
+    def info
+      get("/info")
     end
 
     def info
@@ -57,19 +67,25 @@ module Webflow
     private
 
     def get(path, params: nil)
-      http(path, method: :get, headers: headers, params: params)
+      request(path, method: :get, params: params)
     end
 
     def post(path, data)
-      http(path, method: :post, headers: headers, body: data)
+      request(path, method: :post, body: data)
     end
 
     def put(path, data)
-      http(path, method: :put, headers: headers, body: data)
+      request(path, method: :put, body: data)
     end
 
     def delete(path)
-      http(path, method: :delete, headers: headers)
+      request(path, method: :delete)
+    end
+
+    def request(path, method: :get, params: nil, body: nil)
+      body = Oj.dump(body, OJ_OPTIONS) if body
+      json = http(path, method: method, params: params, headers: request_headers, body: body)
+      Oj.load(json, OJ_OPTIONS)
     end
 
     def http(path, method: :get, params: nil, headers: nil, body: nil)
@@ -79,17 +95,43 @@ module Webflow
         method: method,
         params: params,
         headers: headers,
-        body: (Oj.dump(body) if body),
+        body: body,
       )
-      body = request.run.body
-      Oj.load(body)
+      response = request.run
+
+      track_rate_limit(response.headers)
+
+      response.body
+    end
+
+    def track_rate_limit(headers)
+      rate_limit = headers.select { |key, value| key =~ /X-Ratelimit/ }
+      @rate_limit = rate_limit unless rate_limit.empty?
+      # byebug
     end
 
-    def headers
+    def request_headers
       {
         'Authorization' => "Bearer #{@token}",
         'Content-Type' => 'application/json',
-        'accept-version' => '1.0.0',
+        'Accept-Version' => '1.0.0',
+      }
+    end
+
+    def error_codes
+      # 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.',
       }
     end
   end

data/lib/webflow/ruby.rb

@@ -1,4 +1,2 @@
 require 'webflow/version'
 require 'webflow/client'
-
-Oj.default_options = { mode: :strict, nilnil: true }

data/lib/webflow/version.rb

@@ -1,3 +1,3 @@
 module Webflow
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/webflow.gemspec

@@ -28,4 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webflow-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - phoet
@@ -94,6 +94,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Webflow API bindings for Ruby
 email:
 - phoetmail@googlemail.com