fluffy-ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5293108ca23502a00f4b6692fc74e9ee94c6a449
-  data.tar.gz: 5af10d47249e648805cd4f558868cee181518e35
+  metadata.gz: ff7ee179b75b1a98e5e4555b43c5d712885bb148
+  data.tar.gz: b28e79d8f015d1c4425d7116584bcf9b78d84c72
 SHA512:
-  metadata.gz: 9c1ac80ca83f6f1bccad05ed5fe7b1356e8974553674f3e098db7af75886746d09c3d98ee16113881fc778e8a8d870ddec3aea05f801bc6ef24d71e5442d5a1e
-  data.tar.gz: 068f82d4fcdcddd8bb6313ad7de89df9010e1c458ded93c2f0604c41591ca22579fa402032c29612dc42ec96fe2cae978c3f17b6148fa9d1b5d3a85fd9bb9760
+  metadata.gz: 50d36445fba495fbbc532ce88abdf274b72226c05889a6cab4f745800777866a715b937530118e008b972837f3bc37373ecb934388d5d15eefc12b3b495f5f2e
+  data.tar.gz: 3e1ffe1d7ad28c6cf2e7dde01b53d88e3ef33d1a4b28225b26ff2f0dac568cd10c03072294d5434c6002cf53fa21ec1108bdd6cb8d514445f1272481f1fc27d8

data/README.md

@@ -7,6 +7,8 @@ To install it simply issue the following command:
 ```
 gem install fluffy-ruby
 ```
+## Usage
+Online documentation is available at [rubydoc](http://www.rubydoc.info/gems/fluffy-ruby/).
 
 ## Contact
 Matteo Cerutti - matteo.cerutti@hotmail.co.uk

data/lib/fluffy/api.rb

@@ -1,3 +1,5 @@
+require_relative 'exceptions'
+
 module Fluffy
   module API
     @@api = nil
@@ -6,51 +8,58 @@ module Fluffy
       @@api
     end
 
-    # @return [HTTPClient] HTTP client instance
-    attr_reader :http
-    # @return [String] Fluffy REST API's URL
-    attr_reader :url
+    class RESTClient
+      # @return [HTTPClient] HTTP client instance
+      attr_reader :http
+      # @return [String] Fluffy REST API's URL
+      attr_reader :url
 
-    # Create a Fluffy Client API object
-    #
-    # @param url [String] Fluffy REST API's URL
-    #
-    def initialize(url:)
-      @http = HTTPClient.new
-      @url = url
-    end
+      # Create a Fluffy Client API object
+      #
+      # @param url [String] Fluffy REST API's URL
+      #
+      def initialize(url:)
+        @http = HTTPClient.new
+        @url = url
+      end
 
-    # Perform a HTTP GET request
-    #
-    # @param endpoint [Array[String], String] HTTP API endpoint
-    # @param query [String] HTTP API query parameters
-    # @return [Array[Hash], Hash] API JSON response
-    #
-    def get(endpoint:, query: nil)
-      resp = self.http.get([self.url, endpoint.is_a?(Array) ? endpoint.join('/') : endpoint].join('/'), query, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
-      JSON.parse(resp.body)
-    end
+      # Perform a HTTP GET request
+      #
+      # @param endpoint [Array[String], String] HTTP API endpoint
+      # @param query [String] HTTP API query parameters
+      # @return [Array[Hash], Hash] API JSON response
+      #
+      def get(endpoint:, query: nil)
+        resp = self.http.get([self.url, endpoint.is_a?(Array) ? endpoint.join('/') : endpoint].join('/'), query, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+        data = JSON.parse(resp.body)
+        raise APIError.new(data['message'], data['error'], resp.status) if resp.status >= 400
+        data
+      end
 
-    # Perform a HTTP POST request
-    #
-    # @param endpoint [Array[String], String] HTTP API endpoint
-    # @param params [Hash] HTTP API body
-    # @return [Hash, nil] API JSON response
-    #
-    def post(endpoint:, params: {})
-      puts [self.url, endpoint.is_a?(Array) ? endpoint.join('/') : endpoint].join('/')
-      resp = self.http.post([self.url, endpoint.is_a?(Array) ? endpoint.join('/') : endpoint].join('/'), params.to_json, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
-      JSON.parse(resp.body)
-    end
+      # Perform a HTTP POST request
+      #
+      # @param endpoint [Array[String], String] HTTP API endpoint
+      # @param params [Hash] HTTP API body
+      # @return [Hash, nil] API JSON response
+      #
+      def post(endpoint:, params: {})
+        resp = self.http.post([self.url, endpoint.is_a?(Array) ? endpoint.join('/') : endpoint].join('/'), params.to_json, {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+        data = JSON.parse(resp.body)
+        raise APIError.new(data['message'], data['error'], resp.status) if resp.status >= 400
+        data['message']
+      end
 
-    # Perform a HTTP DELETE request
-    #
-    # @param endpoint [Array[String], String] HTTP API endpoint
-    # @return [Hash, nil] API JSON response
-    #
-    def delete(endpoint:)
-      resp = self.http.delete([self.url, endpoint.is_a?(Array) ? endpoint.join('/') : endpoint].join('/'), {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
-      JSON.parse(resp.body)
+      # Perform a HTTP DELETE request
+      #
+      # @param endpoint [Array[String], String] HTTP API endpoint
+      # @return [Hash, nil] API JSON response
+      #
+      def delete(endpoint:)
+        resp = self.http.delete([self.url, endpoint.is_a?(Array) ? endpoint.join('/') : endpoint].join('/'), {'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+        data = JSON.parse(resp.body)
+        raise APIError.new(data['message'], data['error'], resp.status) if resp.status >= 400
+        data['message']
+      end
     end
   end
 end

data/lib/fluffy/client.rb

@@ -1,7 +1,7 @@
 require 'httpclient'
 require 'json'
 
-require_relative 'client/api'
+#require_relative 'api'
 require_relative 'sessions'
 
 module Fluffy
@@ -19,7 +19,7 @@ module Fluffy
     def initialize(url:, version: 1)
       @url = url
       @version = version
-      @@api = API.new(url: URI.join(url, "v#{version}"))
+      @@api = RESTClient.new(url: URI.join(url, "v#{version}"))
       @sessions = Sessions.new
     end
 

data/lib/fluffy/exceptions.rb

@@ -0,0 +1,15 @@
+module Fluffy
+  class APIError < Exception
+    # @return [Integer] HTTP error code
+    attr_reader :code
+    # @return [String] Reason for error message
+    attr_reader :error
+
+    def initialize(msg, error, code)
+      @code = code
+      @error = error
+
+      super(msg)
+    end
+  end
+end

data/lib/fluffy/version.rb

@@ -1,5 +1,5 @@
 module Fluffy
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 
   def self.version
     VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluffy-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matteo Cerutti
@@ -48,6 +48,7 @@ files:
 - README.md
 - lib/fluffy/api.rb
 - lib/fluffy/client.rb
+- lib/fluffy/exceptions.rb
 - lib/fluffy/session.rb
 - lib/fluffy/session/addressbook.rb
 - lib/fluffy/session/chains.rb