moonrope-client 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2dd9355b29944c25be8b737ed5e21048753719c4
-  data.tar.gz: f22c89a8a92620a2d4eee4b7fb93976c0513d00c
+SHA256:
+  metadata.gz: e354b83a2648af524ba82261be24f4eade87122b4bd042c2b13d81638105d505
+  data.tar.gz: 0a2fef71abb2c870938b97ce60e241fb39ef1b66990be7889a938afd0059c39d
 SHA512:
-  metadata.gz: b4007cd0fedfe8342830b7a7a0cb02dcc188c2955f3aa62e7cad9f93dc6d6b49474fb536d59f07c7a981b4b1d13207545547909a6182725a32d8fd3145b73572
-  data.tar.gz: 2796cd53024fc5766417ab1a74c2bad370feb2adbf71606a30b81e7e05fd12772535f28fd22004124dd2b91b0bc1bb35ddb378a899ab1e6cdfbf3541625cb4c6
+  metadata.gz: 77438b37bc152c59ecdb5a7e4325aa33688ee2f28383fc65c538d51c798e98a00c9b8013041d5a6536f89814c49945461d0fa9e101b1c1551e61703fae509474
+  data.tar.gz: 5e793e6c03c223f0bec41ea11c212edf1fe7b2d938fc392a4c3c80a9cfb293b87391353b4294f775819e8a04bc1b8dabf22924798c0d8c2cbf40fb6b4c3ea694

data/lib/moonrope_client.rb

@@ -12,6 +12,3 @@ require 'moonrope_client/responses/parameter_error'
 require 'moonrope_client/responses/access_denied'
 require 'moonrope_client/responses/validation_error'
 require 'moonrope_client/responses/paginated_collection'
-
-module MoonropeClient
-end

data/lib/moonrope_client/connection.rb

@@ -12,20 +12,20 @@ module MoonropeClient
     def initialize(host, options = {})
       @host, @options = host, options
     end
-    
+
     #
     # @return [String] the endpoint hostname
     #
     attr_reader :host
-    
+
     #
     # @return [String] the path prefix
     #
     def path_prefix
       @options[:path_prefix] || 'api'
     end
-    
-    # 
+
+    #
     # @return [Boolean] whether or not SSL is enabled for requests or not
     #
     def ssl
@@ -33,26 +33,33 @@ module MoonropeClient
     end
 
     #
-    # @return [Integer] the port to conncet to 
+    # @return [Integer] the port to conncet to
     #
     def port
       @options[:port] || (ssl ? 443 : 80)
     end
-    
-    # 
+
+    #
     # @return [Hash] return headers to be set on all requests to the API
     #
     def headers
       @options[:headers] || {}
     end
-    
+
     #
     # @return [Integer] the version of the API to use
     #
     def version
       @options[:version] || 1
     end
-    
+
+    #
+    # @return [String] the User-Agent to send with the request
+    #
+    def user_agent
+      @options[:user_agent] || "Moonrope Ruby Library/#{MoonropeClient::VERSION}"
+    end
+
     #
     # Make a request and return an appropriate request object.
     #
@@ -63,15 +70,19 @@ module MoonropeClient
     def request(controller, action, params = {})
       MoonropeClient::Request.new(self, controller, action, params).make
     end
-    
+
+    def request!(controller, action, params = {})
+      MoonropeClient::Request.new(self, controller, action, params).make!
+    end
+
     def controller(name)
       MoonropeClient::Controller.new(self, name)
     end
-    
+
     def method_missing(name, value = nil)
       value.nil? ? self.controller(name) : super
     end
-    
+
     #
     # Make a request to the remote API server and return the raw output from
     # the request.
@@ -82,20 +93,33 @@ module MoonropeClient
     def raw_request(path, params = {})
       request = Net::HTTP::Post.new(path)
       request.set_form_data(params)
-      request.add_field 'User-Agent', "Moonrope Ruby Library/#{MoonropeClient::VERSION}"
+      request.add_field 'User-Agent', self.user_agent
       headers.each { |k,v| request.add_field k, v }
       connection = Net::HTTP.new(self.host, self.port)
+      connection.open_timeout = @options[:connect_timeout] || 10
       if ssl
         connection.use_ssl = true
-        connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
       end
       result = connection.request(request)
       case result.code.to_i
       when 200 then result.body
-      when 400 then raise Error, "Bad request"
-      else          raise Error, "Internal server error occurred"
+      when 400
+        raise Error.new("Bad request (400)", body: result.body)
+      when 403
+        raise Error.new("Access denied (403)", body: result.body)
+      when 404
+        raise Error.new("Page not found (404)", body: result.body)
+      when 301..309
+        raise Error.new("Redirect (#{result.code})", body: result.body, location: result['Location'])
+      when 500
+        raise Error.new("Internal server error (500)", body: result.body)
+      else
+        raise Error.new("Error (#{result.code.to_i})", body: result.body)
       end
+    rescue Net::OpenTimeout
+      raise Error.new("Connection timeout to #{self.host}:#{self.port}")
     end
-    
+
   end
-end
+end

data/lib/moonrope_client/controller.rb

@@ -1,20 +1,24 @@
 module MoonropeClient
   class Controller
-    
+
     def initialize(connection, controller_name)
       @connection = connection
       @controller_name = controller_name
     end
-    
+
     attr_reader :name
-    
+
     def method_missing(name, params = {})
       request(name, params)
     end
-        
+
     def request(action_name, params = {})
-      @connection.request(@controller_name, action_name, params)
+      if action_name =~ /\A(.*)\!\z/
+        @connection.request!(@controller_name, $1, params)
+      else
+        @connection.request(@controller_name, action_name, params)
+      end
     end
-    
+
   end
 end

data/lib/moonrope_client/error.rb

@@ -1,4 +1,16 @@
 module MoonropeClient
   class Error < StandardError
+    def initialize(message, options = {})
+      @message = message
+      @options = options
+    end
+
+    def to_s
+      @message
+    end
+
+    def options
+      @options
+    end
   end
 end

data/lib/moonrope_client/request.rb

@@ -1,6 +1,8 @@
+require 'moonrope_client/request_error'
+
 module MoonropeClient
   class Request
-    
+
     #
     # Initialize a new request
     #
@@ -15,21 +17,30 @@ module MoonropeClient
       @action = action.to_sym
       @params = params
     end
-    
+
     attr_reader :params
-    
+
     def make
       raw_data_to_response_object(make_request)
     end
-    
+
+    def make!
+      result = raw_data_to_response_object(make_request)
+      if result.success?
+        result
+      else
+        raise MoonropeClient::RequestError.new(result), "Request was not successful. Got #{result.class} (#{result.exception_message})."
+      end
+    end
+
     private
-    
+
     def make_request
       params = {:params => @params.to_json}
       path   = "/#{@connection.path_prefix}/v#{@connection.version}/#{@controller}/#{@action}"
       JSON.parse(@connection.raw_request(path, params))
     end
-    
+
     #
     # Convert rhe result of a request into an appropriate response object
     #
@@ -48,6 +59,6 @@ module MoonropeClient
         MoonropeClient::Response.new(self, data)
       end
     end
-    
+
   end
 end

data/lib/moonrope_client/request_error.rb

@@ -0,0 +1,8 @@
+module MoonropeClient
+  class RequestError < StandardError
+    def initialize(result)
+      @result = result
+    end
+    attr_reader :result
+  end
+end

data/lib/moonrope_client/response.rb

@@ -1,9 +1,9 @@
 module MoonropeClient
   class Response
-    
+
     #
     # Initialize a new response object
-    # 
+    #
     # @param request [MoonropeClient::Request]
     # @param data [Hash]
     #
@@ -11,7 +11,7 @@ module MoonropeClient
       @request = request
       @data = data
     end
-    
+
     #
     # Is this a successful response?
     #
@@ -20,33 +20,40 @@ module MoonropeClient
     def success?
       false
     end
-    
-    # 
+
+    #
     # @return [String] the status of the request returned by the server
     #
     def status
       @data['status']
     end
-    
+
     #
     # @return [Hash] any flags returned by the server
     def flags
       @data['flags']
     end
-    
+
     #
     # @return [Object] the data returned by the server
     #
     def data
       @data['data']
     end
-    
+
     #
     # @return [Float] the time the request took at the server
     #
     def time
       @data['time']
     end
-    
+
+    #
+    # @return [Strig] the string for representing this response in an exception
+    #
+    def exception_message
+      self.data
+    end
+
   end
 end

data/lib/moonrope_client/responses/access_denied.rb

@@ -1,11 +1,15 @@
 module MoonropeClient
   module Responses
     class AccessDenied < Response
-      
+
       def message
         data['message']
       end
-      
+
+      def exception_message
+        self.message
+      end
+
     end
   end
 end

data/lib/moonrope_client/responses/parameter_error.rb

@@ -1,11 +1,15 @@
 module MoonropeClient
   module Responses
     class ParameterError < Response
-      
+
       def message
         data['message']
       end
-      
+
+      def exception_message
+        self.message
+      end
+
     end
   end
 end

data/lib/moonrope_client/responses/validation_error.rb

@@ -1,11 +1,15 @@
 module MoonropeClient
   module Responses
     class ValidationError < Response
-      
+
       def errors
         data['errors']
       end
-      
+
+      def exception_message
+        self.errors.join(', ')
+      end
+
     end
   end
 end

data/lib/moonrope_client/version.rb

@@ -1,3 +1,3 @@
 module MoonropeClient
-  VERSION = '1.0.0'
-end
+  VERSION = '1.0.5'
+end

metadata

@@ -1,55 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: moonrope-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0'
 description: A full client library allows requests to made to Moonrope-enabled API
   endpoints.
 email:
@@ -63,6 +37,7 @@ files:
 - lib/moonrope_client/controller.rb
 - lib/moonrope_client/error.rb
 - lib/moonrope_client/request.rb
+- lib/moonrope_client/request_error.rb
 - lib/moonrope_client/response.rb
 - lib/moonrope_client/responses/access_denied.rb
 - lib/moonrope_client/responses/paginated_collection.rb
@@ -89,10 +64,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A client library for the the Moonrope API server.
 test_files: []
-has_rdoc: