bones-rpc 0.0.1

data/lib/bones/rpc/session.rb

@@ -0,0 +1,195 @@
+# encoding: utf-8
+require 'bones/rpc/read_preference'
+require 'bones/rpc/readable'
+require 'bones/rpc/cluster'
+require 'bones/rpc/context'
+
+module Bones
+  module RPC
+
+    # A session in bones_rpc is root for all interactions with a Bones::RPC server or
+    # replica set.
+    #
+    # It can talk to a single default database, or dynamically speak to multiple
+    # databases.
+    #
+    # @example Single database (console-style)
+    #   session = Bones::RPC::Session.new(["127.0.0.1:27017"])
+    #   session.use(:bones_rpc)
+    #   session[:users].find.one
+    #
+    # @example Multiple databases
+    #   session = Bones::RPC::Session.new(["127.0.0.1:27017"])
+    #   session.with(database: :admin) do |admin|
+    #     admin.command(ismaster: 1)
+    #   end
+    #
+    # @example Authentication
+    #   session = Bones::RPC::Session.new %w[127.0.0.1:27017],
+    #   session.with(database: "admin").login("admin", "s3cr3t")
+    #
+    # @since 1.0.0
+    class Session
+      include Optionable
+
+      # @!attribute cluster
+      #   @return [ Cluster ] The cluster of nodes.
+      # @!attribute options
+      #   @return [ Hash ] The configuration options.
+      attr_reader :cluster, :options
+
+      # Run +command+ on the current database.
+      #
+      # @param (see Bones::RPC::Database#command)
+      #
+      # @return (see Bones::RPC::Database#command)
+      #
+      # @since 1.0.0
+      def command(op)
+        current_database.command(op)
+      end
+
+      def context
+        @context ||= Context.new(self)
+      end
+
+      # Disconnects all nodes in the session's cluster. This should only be used
+      # in cases # where you know you're not going to use the cluster on the
+      # thread anymore and need to force the connections to close.
+      #
+      # @return [ true ] True if the disconnect succeeded.
+      #
+      # @since 1.2.0
+      def disconnect
+        cluster.disconnect
+      end
+
+      def handle_refresh(node)
+        @callback.call(node) if @callback
+      end
+
+      # Provide a string inspection for the session.
+      #
+      # @example Inspect the session.
+      #   session.inspect
+      #
+      # @return [ String ] The string inspection.
+      #
+      # @since 1.4.0
+      def inspect
+        "<#{self.class.name} seeds=#{cluster.seeds}>"
+      end
+
+      # Setup validation of allowed read preference options.
+      #
+      # @since 2.0.0
+      option(:read).allow(
+        :nearest
+      )
+
+      # Setup validation of allowed database options. (Any string or symbol)
+      #
+      # @since 2.0.0
+      option(:adapter).allow(Optionable.any(String), Optionable.any(Symbol), Optionable.any(Module))
+
+      # Setup validation of allowed max retry options. (Any integer)
+      #
+      # @since 2.0.0
+      option(:max_retries).allow(Optionable.any(Integer))
+
+      # Setup validation of allowed pool size options. (Any integer)
+      #
+      # @since 2.0.0
+      option(:pool_size).allow(Optionable.any(Integer))
+
+      # Setup validation of allowed retry interval options. (Any numeric)
+      #
+      # @since 2.0.0
+      option(:retry_interval).allow(Optionable.any(Numeric))
+
+      # Setup validation of allowed reap interval options. (Any numeric)
+      #
+      # @since 2.0.0
+      option(:reap_interval).allow(Optionable.any(Numeric))
+
+      # Setup validation of allowed ssl options. (Any boolean)
+      #
+      # @since 2.0.0
+      option(:ssl).allow(true, false)
+
+      # Setup validation of allowed timeout options. (Any numeric)
+      #
+      # @since 2.0.0
+      option(:timeout).allow(Optionable.any(Numeric))
+
+      # Initialize a new database session.
+      #
+      # @example Initialize a new session.
+      #   Session.new([ "localhost:27017" ])
+      #
+      # @param [ Array ] seeds An array of host:port pairs.
+      # @param [ Hash ] options The options for the session.
+      #
+      # @see Above options validations for allowed values in the options hash.
+      #
+      # @since 1.0.0
+      def initialize(seeds, options = {}, &callback)
+        validate_strict(options)
+        @options = options
+        @callback = callback
+        @cluster = Cluster.new(self, seeds)
+      end
+
+      def notify(method, *params)
+        context.notify(method, params)
+      end
+
+      # Get the read preference for the session. Will default to primary if none
+      # was provided.
+      #
+      # @example Get the session's read preference.
+      #   session.read_preference
+      #
+      # @return [ Object ] The read preference.
+      #
+      # @since 2.0.0
+      def read_preference
+        @read_preference ||= ReadPreference.get(options[:read] || :nearest)
+      end
+
+      def request(method, *params)
+        context.request(method, params)
+      end
+
+      def synchronize
+        context.synchronize
+      end
+
+      class << self
+
+        # Create a new session from a URI.
+        #
+        # @example Initialize a new session.
+        #   Session.connect("bones-rpc://localhost:27017/my_db")
+        #
+        # @param [ String ] Bones::RPC URI formatted string.
+        #
+        # @return [ Session ] The new session.
+        #
+        # @since 3.0.0
+        def connect(uri, &block)
+          uri = Uri.new(uri)
+          session = new(*uri.bones_rpc_arguments, &block)
+          session
+        end
+      end
+
+      private
+
+      def initialize_copy(_)
+        @options = @options.dup
+        @read_preference = nil
+      end
+    end
+  end
+end

data/lib/bones/rpc/uri.rb

@@ -0,0 +1,222 @@
+# encoding: utf-8
+module Bones
+  module RPC
+
+    # Parses Bones::RPC uri
+    #
+    # @since 1.3.0
+    class Uri
+
+      # Get the scheme pattern.
+      #
+      # @since 1.3.0
+      SCHEME = /(bones-rpc:\/\/)/
+
+      # The user name pattern.
+      #
+      # @since 1.3.0
+      USER = /([-.\w:]+)/
+
+      # The password pattern.
+      #
+      # @since 1.3.0
+      PASS = /([^@,]+)/
+
+      # The nodes pattern.
+      #
+      # @since 1.3.0
+      NODES = /((([-.\w]+)(?::(\w+))?,?)+)/
+
+      # The database pattern.
+      #
+      # @since 1.3.0
+      DATABASE = /(?:\/([-\w]+))?/
+
+      # The options pattern.
+      #
+      # @since 1.3.0
+      OPTIONS  = /(?:\?(.+))/
+
+      # The full URI pattern.
+      #
+      # @since 1.3.0
+      URI = /#{SCHEME}(#{USER}:#{PASS}@)?#{NODES}#{DATABASE}#{OPTIONS}?/
+
+      # The options that have to do with write concerns.
+      #
+      # @since 2.0.0
+      WRITE_OPTIONS = [ "w", "j", "fsync", "wtimeout" ].freeze
+
+      # The mappings from read preferences in the URI to Bones::RPC's.
+      #
+      # @since 2.0.0
+      READ_MAPPINGS = {
+        "nearest" => :nearest,
+        "primary" => :primary,
+        "primarypreferred" => :primary_preferred,
+        "secondary" => :secondary,
+        "secondarypreferred" => :secondary_preferred
+      }.freeze
+
+      # @!attribute match
+      #   @return [ Array ] The uri match.
+      attr_reader :match
+
+      # Helper to determine if authentication is provided
+      #
+      # @example Boolean response if username/password given
+      #   uri.auth_provided?
+      #
+      # @return [ true, false ] If authorization is provided.
+      #
+      # @since 1.3.0
+      def auth_provided?
+        !username.nil? && !password.nil?
+      end
+
+      # Get the database provided in the URI.
+      #
+      # @example Get the database.
+      #   uri.database
+      #
+      # @return [ String ] The database.
+      #
+      # @since 1.3.0
+      def database
+        @database ||= match[9]
+      end
+
+      # Get the hosts provided in the URI.
+      #
+      # @example Get the hosts.
+      #   uri.hosts
+      #
+      # @return [ Array<String> ] The hosts.
+      #
+      # @since 1.3.0
+      def hosts
+        @hosts ||= match[5].split(",")
+      end
+
+      # Create the new uri from the provided string.
+      #
+      # @example Create the new uri.
+      #   Bones::RPC::Uri.new(uri)
+      #
+      # @param [ String ] string The uri string.
+      #
+      # @since 1.3.0
+      def initialize(string)
+        @match = string.match(URI)
+        invalid_uri!(string) unless @match
+      end
+
+      # Raise a human readable error when improper URI provided
+      #
+      # @example Raise error and provide guidance on invalid URI
+      #   Bones::RPC::Uri.invalid!(uri)
+      #
+      # @param [ String ] Invalid string
+      #
+      # @since 1.3.1
+      def invalid_uri!(string)
+        scrubbed = string.gsub(/[^:]+@/, '<password>@')
+        raise Errors::InvalidBonesRPCURI, "The provided connection string is not a value URI: #{scrubbed}"
+      end
+
+      # Get the options provided in the URI.
+      #
+      # @example Get the options
+      #   uri.options
+      #
+      # @note The options provided in the URI string must match the Bones::RPC
+      #   specification.
+      #
+      # @return [ Hash ] Options hash usable by Moped
+      #
+      # @since 1.3.0
+      def options
+        options_string, options = match[10], {}
+        unless options_string.nil?
+          options_string.split(/\&/).each do |option_string|
+            key, value = option_string.split(Regexp.new('='))
+            if WRITE_OPTIONS.include?(key)
+              options[:write] = { key.to_sym => cast(value) }
+            elsif read = READ_MAPPINGS[value.downcase]
+              options[:read] = read
+            else
+              options[key.to_sym] = cast(value)
+            end
+          end
+        end
+        options
+      end
+
+      # Get the password provided in the URI.
+      #
+      # @example Get the password.
+      #   uri.password
+      #
+      # @return [ String ] The password.
+      #
+      # @since 1.3.0
+      def password
+        @password ||= match[4]
+      end
+
+      # Get the uri as a Bones::RPC friendly configuration hash.
+      #
+      # @example Get the uri as a hash.
+      #   uri.to_hash
+      #
+      # @return [ Hash ] The uri as options.
+      #
+      # @since 1.3.0
+      def to_hash
+        config = { database: database, hosts: hosts }
+        if username && password
+          config.merge!(username: username, password: password)
+        end
+        config
+      end
+
+      # Create Bones::RPC usable arguments
+      #
+      # @example Get the bones_rpc args
+      #   uri.bones_rpc_arguments
+      #
+      # @return [ Array ] Array of arguments usable by bones_rpc
+      #
+      # @since 1.3.0
+      def bones_rpc_arguments
+        [ hosts, options ]
+      end
+
+      # Get the username provided in the URI.
+      #
+      # @example Get the username.
+      #   uri.username
+      #
+      # @return [ String ] The username.
+      #
+      # @since 1.3.0
+      def username
+        @username ||= match[3]
+      end
+
+      private
+
+      def cast(value)
+        if value == "true"
+          true
+        elsif value == "false"
+          false
+        elsif value =~ /[\d]/
+          value.to_i
+        else
+          value.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/bones/rpc/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module Bones
+  module RPC
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: bones-rpc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Bennett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: celluloid-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: erlang-etf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: optionable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bones::RPC client for ruby
+email:
+- andrew@delorum.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bones-rpc.gemspec
+- lib/bones-rpc.rb
+- lib/bones/rpc.rb
+- lib/bones/rpc/adapter.rb
+- lib/bones/rpc/adapter/base.rb
+- lib/bones/rpc/adapter/erlang.rb
+- lib/bones/rpc/adapter/json.rb
+- lib/bones/rpc/adapter/msgpack.rb
+- lib/bones/rpc/adapter/parser.rb
+- lib/bones/rpc/address.rb
+- lib/bones/rpc/cluster.rb
+- lib/bones/rpc/connection.rb
+- lib/bones/rpc/connection/reader.rb
+- lib/bones/rpc/connection/socket.rb
+- lib/bones/rpc/connection/socket/connectable.rb
+- lib/bones/rpc/connection/socket/ssl.rb
+- lib/bones/rpc/connection/socket/tcp.rb
+- lib/bones/rpc/connection/writer.rb
+- lib/bones/rpc/context.rb
+- lib/bones/rpc/errors.rb
+- lib/bones/rpc/failover.rb
+- lib/bones/rpc/failover/disconnect.rb
+- lib/bones/rpc/failover/ignore.rb
+- lib/bones/rpc/failover/retry.rb
+- lib/bones/rpc/future.rb
+- lib/bones/rpc/instrumentable.rb
+- lib/bones/rpc/instrumentable/log.rb
+- lib/bones/rpc/instrumentable/noop.rb
+- lib/bones/rpc/loggable.rb
+- lib/bones/rpc/node.rb
+- lib/bones/rpc/node/registry.rb
+- lib/bones/rpc/parser.rb
+- lib/bones/rpc/parser/buffer.rb
+- lib/bones/rpc/protocol.rb
+- lib/bones/rpc/protocol/acknowledge.rb
+- lib/bones/rpc/protocol/adapter_helper.rb
+- lib/bones/rpc/protocol/binary_helper.rb
+- lib/bones/rpc/protocol/ext_message.rb
+- lib/bones/rpc/protocol/notify.rb
+- lib/bones/rpc/protocol/request.rb
+- lib/bones/rpc/protocol/response.rb
+- lib/bones/rpc/protocol/synchronize.rb
+- lib/bones/rpc/read_preference.rb
+- lib/bones/rpc/read_preference/nearest.rb
+- lib/bones/rpc/read_preference/selectable.rb
+- lib/bones/rpc/readable.rb
+- lib/bones/rpc/session.rb
+- lib/bones/rpc/uri.rb
+- lib/bones/rpc/version.rb
+homepage: ''
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Bones::RPC client for ruby
+test_files: []