remotr 0.1.3 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b86be1a17065f1e2ba62cbd6a57ff4dd4c771eed
-  data.tar.gz: 6d97ba9c85f03a8da80f7e61815b09f51b88d036
+  metadata.gz: 12851189a061bb27e591ff38748c84e5145d930a
+  data.tar.gz: 2aab34dd644d9c60fd318c23ca57c3f0e143c881
 SHA512:
-  metadata.gz: a32a14d7378d2a89d85d0c631096dc639d378ef68fee01f1480fff4a6927625cd8c987855cd4a759a8167a0e199c3b32f997305d4a6480c9aaf1d1c3ad748ed7
-  data.tar.gz: 8cbed702ea2b1272bd968a21b6d31a4a07a4cac92d56427ff157312610fa782b36c61ab9d0e7fc70b8ad96ee9fcf25b834842a1d669a7178915de7685b062013
+  metadata.gz: 68010968966867568fd8ea17157cf17ccfe680a848710ba4e68a4c9f392bcda6d60196ca65f344a58d27b8eae5e83f44f614c3da2ce22492be72506373ede9c3
+  data.tar.gz: 1e235e0dca4cc4bbdd70006336540bbe959e8966a6401d73f6cf762af8d77b72b97a69543be921cb5b7ac04558d88d226d3732b2bb011075e3c6bc1a5e3c9b74

data/README.md

@@ -1,14 +1,26 @@
+# Remotr
+
 Example usage:
 
 ```ruby
-module RemoteExpress
-  module Hub
+module RemoteMyApp
+  include Remotr::Configurable
+end
+
+RemoteMyApp.configure do |config|
+  config.base_uri    = 'https://myapp.example.com'
+  config.api_key     = 'abcdef'
+  config.api_version = 1
+  config.base_path   = "/api/v#{config.api_version}"
+end
+
+module RemoteMyApp
+  module Event
     include Remotr::Respondable
 
     def self.all
-      respond_with get('/hubs'), 'hubs'
+      respond_with get('/events'), :events
     end
-
   end
 end
 ```

data/lib/remotr/configurable.rb

@@ -1,24 +1,28 @@
 require 'remotr/configuration'
+require 'active_support/concern'
 
 module Remotr
   module Configurable
+    extend ActiveSupport::Concern
 
-    # Public: Returns the the configuration instance.
-    #
-    def config
-      @config ||= ::Remotr::Configuration.new
-    end
+    module ClassMethods
+      # Public: Returns the the configuration instance.
+      #
+      def config
+        @config ||= ::Remotr::Configuration.new
+      end
 
-    # Public: Yields the configuration instance.
-    #
-    def configure(&block)
-      yield config
-    end
+      # Public: Yields the configuration instance.
+      #
+      def configure(&block)
+        yield config
+      end
 
-    # Public: Reset the configuration (useful for testing).
-    #
-    def reset!
-      @config = nil
+      # Public: Reset the configuration (useful for testing).
+      #
+      def reset!
+        @config = nil
+      end
     end
 
   end

data/lib/remotr/configuration.rb

@@ -1,5 +1,5 @@
 module Remotr
   class Configuration
-    attr_accessor :base_uri, :base_path, :api_version, :api_key
+    attr_accessor :base_uri, :base_path, :api_version, :api_key, :default_timeout
   end
 end

data/lib/remotr/respondable.rb

@@ -45,23 +45,39 @@ module Remotr
         url          = URI.join(config.base_uri, path).to_s
 
         fail ArgumentError unless %w( get post delete put update ).include? method.to_s
-        HTTParty.send method, url, query: query_params, body: body, headers: { 'Accept' => 'application/json' }
-      end
-
-      def respond_with(httparty_response, custom_namespace = nil)
-        use_namespace = custom_namespace || namespace
-        object = httparty_response.parsed_response ? httparty_response.parsed_response[use_namespace.to_s] : nil
+        httparty_response = HTTParty.send method, url, timeout: timeout_in_seconds, query: query_params, body: body, headers: { 'Accept' => 'application/json' }
 
         if httparty_response.code.to_i.between? 200, 299
-          Operations.success :remote_request_succeeded, object: object, code: httparty_response.code, body: httparty_response.body
+          Operations.success :request_succeeded, object: httparty_response
         else
-          Operations.failure :remote_request_failed, object: httparty_response, code: httparty_response.code
+          Operations.failure :request_failed, object: httparty_response
         end
 
+      rescue => exception
+        Operations.failure :connection_failed, object: exception
+      end
+
+      def respond_with(request_operation, namespace_to_use = namespace)
+        return request_operation if request_operation.failure?
+        httparty_response = request_operation.object
+
+        return Operations.failure(:response_missing_content_type, object: httparty_response) unless httparty_response.content_type
+        return Operations.failure(:response_is_not_json, object: httparty_response) unless httparty_response.content_type == 'application/json'
+        parsed_response = httparty_response.parsed_response
+        return Operations.failure(:response_missing_success_flag, object: httparty_response) unless parsed_response && parsed_response.key?('success')
+        return Operations.failure(:response_unsuccessful, object: httparty_response) if parsed_response['success'].to_s != 'true'
+
+        object = parsed_response ? parsed_response[namespace_to_use.to_s] : nil
+
+        Operations.success :request_succeeded, object: object, code: httparty_response.code, body: httparty_response.body
+
       rescue JSON::ParserError
-        Operations.failure :remote_request_parsing_failed, object: httparty_response
+        Operations.failure :json_parsing_failed, object: httparty_response
       end
 
+      def timeout_in_seconds
+        config.default_timeout
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remotr
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.1
 platform: ruby
 authors:
 - bukowskis