moonrope-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2dd9355b29944c25be8b737ed5e21048753719c4
+  data.tar.gz: f22c89a8a92620a2d4eee4b7fb93976c0513d00c
+SHA512:
+  metadata.gz: b4007cd0fedfe8342830b7a7a0cb02dcc188c2955f3aa62e7cad9f93dc6d6b49474fb536d59f07c7a981b4b1d13207545547909a6182725a32d8fd3145b73572
+  data.tar.gz: 2796cd53024fc5766417ab1a74c2bad370feb2adbf71606a30b81e7e05fd12772535f28fd22004124dd2b91b0bc1bb35ddb378a899ab1e6cdfbf3541625cb4c6

data/lib/moonrope_client/connection.rb

@@ -0,0 +1,101 @@
+module MoonropeClient
+  class Connection
+
+    #
+    # Initialize a new connection object to an API
+    #
+    #   moonrope = MoonropeClient::Connection.new('myapp.com', :ssl => true, :path_prefix => 'api')
+    #
+    # @param host [String] the hostname to connect to
+    # @param options [Hash] A hash of options for this connectin
+    #
+    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
+      @options[:ssl] || false
+    end
+
+    #
+    # @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
+    
+    #
+    # Make a request and return an appropriate request object.
+    #
+    # @param controller [Symbol] the controller
+    # @param action [Symbol] the action
+    # @param params [Hash] parameters
+    #
+    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.
+    #
+    # @param path [String] the full path to request
+    # @param params [Hash] a hash of parameters to send with the request
+    #
+    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}"
+      headers.each { |k,v| request.add_field k, v }
+      connection = Net::HTTP.new(self.host, self.port)
+      if ssl
+        connection.use_ssl = true
+        connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      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"
+      end
+    end
+    
+  end
+end

data/lib/moonrope_client/controller.rb

@@ -0,0 +1,20 @@
+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)
+    end
+    
+  end
+end

data/lib/moonrope_client/error.rb

@@ -0,0 +1,4 @@
+module MoonropeClient
+  class Error < StandardError
+  end
+end

data/lib/moonrope_client/request.rb

@@ -0,0 +1,53 @@
+module MoonropeClient
+  class Request
+    
+    #
+    # Initialize a new request
+    #
+    # @param connection [MoonropeClient::Connection]
+    # @param controller [Symbol]
+    # @param action [Symbol]
+    # @param params [Hash]
+    #
+    def initialize(connection, controller, action, params = {})
+      @connection = connection
+      @controller = controller.to_sym
+      @action = action.to_sym
+      @params = params
+    end
+    
+    attr_reader :params
+    
+    def make
+      raw_data_to_response_object(make_request)
+    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
+    #
+    def raw_data_to_response_object(data)
+      case data['status']
+      when 'success'
+        if data['flags']['paginated'] && data['data'].is_a?(Array)
+          MoonropeClient::Responses::PaginatedCollection.new(self, data)
+        else
+          MoonropeClient::Responses::Success.new(self, data)
+        end
+      when 'parameter-error'  then MoonropeClient::Responses::ParameterError.new(self, data)
+      when 'access-denied'    then MoonropeClient::Responses::AccessDenied.new(self, data)
+      when 'validation-error' then MoonropeClient::Responses::ValidationError.new(self, data)
+      else
+        MoonropeClient::Response.new(self, data)
+      end
+    end
+    
+  end
+end

data/lib/moonrope_client/response.rb

@@ -0,0 +1,52 @@
+module MoonropeClient
+  class Response
+    
+    #
+    # Initialize a new response object
+    # 
+    # @param request [MoonropeClient::Request]
+    # @param data [Hash]
+    #
+    def initialize(request, data)
+      @request = request
+      @data = data
+    end
+    
+    #
+    # Is this a successful response?
+    #
+    # @return [Boolean]
+    #
+    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
+    
+  end
+end

data/lib/moonrope_client/responses/access_denied.rb

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

data/lib/moonrope_client/responses/paginated_collection.rb

@@ -0,0 +1,71 @@
+module MoonropeClient
+  module Responses
+    class PaginatedCollection < Success
+      
+      #
+      # @return [Hash] all properties regarding pagination
+      #
+      def pagination_properties
+        flags['paginated']
+      end
+      
+      #
+      # @return [Integer] the current page
+      #
+      def page
+        pagination_properties['page']
+      end
+      
+      #
+      # @return [Integer] the total records per page
+      #
+      def per_page
+        pagination_properties['per_page']
+      end
+      
+      #
+      # @return [Integer] the total number of pages
+      #
+      def total_pages
+        pagination_properties['total_pages']
+      end
+      
+      #
+      # @return [Integer] the total number of records
+      #
+      def total_records
+        pagination_properties['total_records']
+      end
+      
+      #
+      # @return [Array] all the items
+      #
+      def records
+        data
+      end
+      
+      #
+      # @return [MoonropeClient::Responses::PaginatedCollection] the collection for the next page
+      #
+      def next_page
+        request = @request.dup
+        request.params[:page] = page + 1
+        request.make
+      end
+
+      #
+      # @return [MoonropeClient::Responses::PaginatedCollection] the collection for the previous page
+      #
+      def previous_page
+        if page > 1
+          request = @request.dup
+          request.params[:page] = page - 1
+          request.make
+        else
+          raise Error, "Cannot return the previous page as there is no page before page #{page}"
+        end
+      end
+      
+    end
+  end
+end

data/lib/moonrope_client/responses/parameter_error.rb

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

data/lib/moonrope_client/responses/success.rb

@@ -0,0 +1,32 @@
+module MoonropeClient
+  module Responses
+    class Success < Response
+      
+      def success?
+        true
+      end
+      
+      #
+      # @return [Boolean] whether this is a creation or not
+      #
+      def creation?
+        flags['creation']
+      end
+      
+      #
+      # @return [Boolean] whether this is a modification or not
+      #
+      def modification?
+        flags['modification']
+      end
+      
+      #
+      # @return [Boolean] whether this is a deletion or not
+      #
+      def deletion?
+        flags['deletion']
+      end
+      
+    end
+  end
+end

data/lib/moonrope_client/responses/validation_error.rb

@@ -0,0 +1,11 @@
+module MoonropeClient
+  module Responses
+    class ValidationError < Response
+      
+      def errors
+        data['errors']
+      end
+      
+    end
+  end
+end

data/lib/moonrope_client/version.rb

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

data/lib/moonrope_client.rb

@@ -0,0 +1,17 @@
+require 'net/https'
+require 'json'
+
+require 'moonrope_client/version'
+require 'moonrope_client/connection'
+require 'moonrope_client/error'
+require 'moonrope_client/controller'
+require 'moonrope_client/request'
+require 'moonrope_client/response'
+require 'moonrope_client/responses/success'
+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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: moonrope-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-09 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
+  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
+description: A full client library allows requests to made to Moonrope-enabled API
+  endpoints.
+email:
+- adam@atechmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/moonrope_client.rb
+- lib/moonrope_client/connection.rb
+- lib/moonrope_client/controller.rb
+- lib/moonrope_client/error.rb
+- lib/moonrope_client/request.rb
+- lib/moonrope_client/response.rb
+- lib/moonrope_client/responses/access_denied.rb
+- lib/moonrope_client/responses/paginated_collection.rb
+- lib/moonrope_client/responses/parameter_error.rb
+- lib/moonrope_client/responses/success.rb
+- lib/moonrope_client/responses/validation_error.rb
+- lib/moonrope_client/version.rb
+homepage: http://adamcooke.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A client library for the the Moonrope API server.
+test_files: []
+has_rdoc: