tilda-simple-api 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d296dba5753bd820993d7796198cfc47553dcfbd
-  data.tar.gz: f0dcda9e4013c58344cc0e14364943cd36aa1b93
+  metadata.gz: 1c08f2b15626300a8c3ca48e18ece75485affdad
+  data.tar.gz: 2f64a02a11f40b8365bcaa4f172d57b1fdab541c
 SHA512:
-  metadata.gz: cd2d4df301ded5090304734e39758efc3743a00709d02f076f7236c80988d593b383c6600241127d4b995d4096da3bbbcdbce112941fd9a2def78a510bbae6a0
-  data.tar.gz: 33169015ae087a89461fa91f66d0cd1961bae3b522385e869190a875ea67c0e300dc9bf6815c84a8f46eb48a87d7a6958fc2a0e07f5c4b13006f6e52245845c3
+  metadata.gz: ec265f4edfed9ccf4c7cd47aeae0a7ae35572c97efb5a8239c74241189a9bbf6ed7040ab6ee65814760293ebfc7d01fe7a2cf977cb0ebfe0a529defaef9cd563
+  data.tar.gz: e72884ae0d2b43d12e838c8e1bd77f6b9f019c69d7a257d7272ac699cdb055333794fc1b10909f16301d96b60565525f96e207e54a63b6d2270c72b26bdf1a52

data/README.md

@@ -1,4 +1,5 @@
 # Tilda::Simple::Api
+[![Gem Version](https://badge.fury.io/rb/tilda-simple-api.svg)](https://badge.fury.io/rb/tilda-simple-api)
 [![Build Status](https://travis-ci.org/gururuby/tilda-simple-api.svg?branch=master)](https://travis-ci.org/gururuby/tilda-simple-api)
 [![Maintainability](https://api.codeclimate.com/v1/badges/f9b19b95e9b50be1a52f/maintainability)](https://codeclimate.com/github/gururuby/tilda-simple-api/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/f9b19b95e9b50be1a52f/test_coverage)](https://codeclimate.com/github/gururuby/tilda-simple-api/test_coverage)
@@ -31,6 +32,7 @@ Configuration api:
     config.secret_key = "your-secret-key"
     # config.api_version = "v1" # by default'
     # config.api_host = "http://api.tildacdn.info" # by default'
+    # config.raise_api_errors = false # by_default
   end
 ```
 
@@ -55,6 +57,17 @@ API requests example
 | **page info for export(only body)** | `tilda_api.page_export(page_id)`           | http://help.tilda.ws/api#getpageexport        |
 | **full page info for export**       | `tilda_api.page_full_export(page_id)`      | http://help.tilda.ws/api#getpagefullexport    |
 
+### API Errors
+When switch `config.raise_api_errors` to `true`. API raise errors. Here is available API Errors:
+
+| API Error                                         | Error case                                      | 
+| --------------------------------------------------|-------------------------------------------------|
+| **Tilda::Simple::Api::Errors::InvalidCredentials**| invalid public_key or secret_key passed         |
+| **Tilda::Simple::Api::Errors::ProjectNotFound**   | tilda api not found project by passed project_id|
+| **Tilda::Simple::Api::Errors::PageNotFound**      | tilda api not found page by passed page_id      |
+| **Tilda::Simple::Api::Errors::Error**             | in all other cases                              |
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tilda-simple-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/tilda/simple/api.rb

@@ -1,6 +1,7 @@
 require 'httparty'
 require 'tilda/simple/api/config'
 require 'tilda/simple/api/errors'
+require 'tilda/simple/api/errors_handler'
 require 'tilda/simple/api/request'
 require 'tilda/simple/api/version'
 

data/lib/tilda/simple/api/config.rb

@@ -2,11 +2,12 @@ module Tilda
   module Simple
     module Api
       class Config
-        attr_accessor :api_host, :api_version, :public_key, :secret_key
+        attr_accessor :api_host, :api_version, :public_key, :secret_key, :raise_api_errors
 
         def initialize
           @api_version = 'v1'
           @api_host = 'http://api.tildacdn.info'
+          @raise_api_errors = false
         end
       end
     end

data/lib/tilda/simple/api/errors.rb

@@ -3,15 +3,9 @@ module Tilda
     module Api
       module Errors
         class Error < StandardError; end
-
-        class ResponseError < Error
-          attr_reader :status_code
-
-          def initialize(response)
-            @message = response.message
-            @status_code = response.code
-          end
-        end
+        class InvalidCredentials < Error; end
+        class ProjectNotFound < Error; end
+        class PageNotFound < Error; end
       end
     end
   end

data/lib/tilda/simple/api/errors_handler.rb

@@ -0,0 +1,36 @@
+module Tilda
+  module Simple
+    module Api
+      module ErrorsHandler
+        def get(path, params = {})
+          handle_errors { super(path, params) }
+        end
+
+        private
+
+        def handle_errors(&block)
+          response = block.call
+          check_response(response) if Api.config.raise_api_errors
+          response
+        end
+
+        def check_response(response)
+          raise api_error_class(response), response['message'] if response['status'] == 'ERROR'
+        end
+
+        def api_error_class(response)
+          case response['message']
+          when /Wrong Secret Key length|Wrong Public Key length/
+            Errors::InvalidCredentials
+          when /Can't find project with this 'projectid' parameter/
+            Errors::ProjectNotFound
+          when /Can't find page with this 'pageid' parameter/
+            Errors::PageNotFound
+          else
+            Errors::Error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilda/simple/api/request.rb

@@ -2,52 +2,49 @@ module Tilda
   module Simple
     module Api
       class Request
-        class << self
-          def new(public_key:nil, secret_key:nil)
-            Class.new(AbstractRequest){|klass|
-              config = Api.config
-              public_key ||= config.public_key
-              secret_key ||= config.secret_key
-              klass.base_uri "#{config.api_host}/#{config.api_version}"
-              klass.default_params publickey: public_key, secretkey: secret_key
-            }.new
-          end
-        end
-
-        class AbstractRequest
-          include HTTParty
-
-          def projects_list
-            self.class.get('/getprojectslist')
-          end
-
-          def project(project_id)
-            self.class.get('/getproject', query: { projectid: project_id })
-          end
-
-          def project_export(project_id)
-            self.class.get('/getprojectexport', query: { projectid: project_id })
-          end
-
-          def pages_list(project_id)
-            self.class.get('/getpageslist', query: { projectid: project_id })
-          end
-
-          def page(page_id)
-            self.class.get('/getpage', query: { pageid: page_id })
-          end
-
-          def page_full(page_id)
-            self.class.get('/getpagefull', query: { pageid: page_id })
-          end
-
-          def page_export(page_id)
-            self.class.get('/getpageexport', query: { pageid: page_id })
-          end
-
-          def page_full_export(page_id)
-            self.class.get('/getpagefullexport', query: { pageid: page_id })
-          end
+        include HTTParty
+        extend ErrorsHandler
+
+        def initialize(public_key: nil, secret_key: nil)
+          config = Api.config
+
+          public_key ||= config.public_key
+          secret_key ||= config.secret_key
+
+          self.class.base_uri "#{config.api_host}/#{config.api_version}"
+          self.class.default_params publickey: public_key, secretkey: secret_key
+        end
+
+        def projects_list
+          self.class.get('/getprojectslist')
+        end
+
+        def project(project_id)
+          self.class.get('/getproject', query: { projectid: project_id })
+        end
+
+        def project_export(project_id)
+          self.class.get('/getprojectexport', query: { projectid: project_id })
+        end
+
+        def pages_list(project_id)
+          self.class.get('/getpageslist', query: { projectid: project_id })
+        end
+
+        def page(page_id)
+          self.class.get('/getpage', query: { pageid: page_id })
+        end
+
+        def page_full(page_id)
+          self.class.get('/getpagefull', query: { pageid: page_id })
+        end
+
+        def page_export(page_id)
+          self.class.get('/getpageexport', query: { pageid: page_id })
+        end
+
+        def page_full_export(page_id)
+          self.class.get('/getpagefullexport', query: { pageid: page_id })
         end
       end
     end

data/lib/tilda/simple/api/version.rb

@@ -1,7 +1,7 @@
 module Tilda
   module Simple
     module Api
-      VERSION = "0.1.1"
+      VERSION = "0.2.0"
     end
   end
 end

data/tilda-simple-api.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 1.9.3'
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tilda-simple-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - V. Miroshnichenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-12 00:00:00.000000000 Z
+date: 2018-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,7 @@ files:
 - lib/tilda/simple/api.rb
 - lib/tilda/simple/api/config.rb
 - lib/tilda/simple/api/errors.rb
+- lib/tilda/simple/api/errors_handler.rb
 - lib/tilda/simple/api/request.rb
 - lib/tilda/simple/api/version.rb
 - tilda-simple-api.gemspec
@@ -130,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="