sqlcached_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f642ec5bff84d1fb7738aff7fedad4d695e8224
+  data.tar.gz: 0168729e04f2d4eca81b5159e09efaa8c0cedd5f
+SHA512:
+  metadata.gz: 5a96a6163594e8a34a86e93b503552d453bd67b0ff96ef4da4b97386da954fdf767504acf3876b1903bf06e18e3e519bc940ca60b3ded5f63fc2bbc34e813361
+  data.tar.gz: d494b4126fa2e8fb60ddfa7562675b48e6f94e9fd9474f2712d51631a11117905c3d9934fe2250b1f1ea4f9bfed498916697d672ec065c8bcbfd632e442f8097

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sqlcached_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Roberto Maestroni
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# SqlcachedClient
+
+A Ruby client for [Sqlcached](https://github.com/rmaestroni/sqlcached).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sqlcached_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sqlcached_client
+
+## Usage
+
+Create your models as you would do with `ActiveRecord`.
+
+```ruby
+require 'sqlcached_client'
+
+class Base < SqlcachedClient::Entity
+  # things shared amongst all models
+  server({ host: 'localhost', port: 8081 })
+end
+
+
+class User < Base
+  entity_name 'user'
+
+  query <<-SQL
+    SELECT * FROM users WHERE id IN ({{ ids }})
+  SQL
+
+  has_many :posts, where: { user_id: :id }
+
+  has_many :pictures, class_name: 'Image',
+    where: { imageable_id: :id, imageable_type: 'User' }
+
+  has_one :address, where: { user_id: :id }
+end
+
+
+class Post < Base
+  entity_name 'post'
+
+  query <<-SQL
+    SELECT * FROM posts WHERE author_id = {{ user_id }}
+  SQL
+end
+
+```
+
+Run some queries:
+```ruby
+users = User.where(ids: '1, 2, 3, 4')
+
+users[0].pictures.each # you can navigate through the associations
+```
+
+Load in memory every associated set recursively:
+```ruby
+users.build_associations # for each entity in the resultset, or...
+users[0].build_associations # for a single entity
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/rmaestroni/sqlcached_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sqlcached_client/entity.rb

@@ -0,0 +1,152 @@
+require 'sqlcached_client/hash_struct'
+require 'sqlcached_client/resultset'
+require 'sqlcached_client/server'
+
+module SqlcachedClient
+  class Entity < HashStruct
+
+    attr_reader :attribute_names
+
+    # @param attributes [Hash]
+    def initialize(attributes)
+      @attribute_names = attributes.keys
+      super(attributes)
+    end
+
+
+    class << self
+      attr_reader :query_id
+
+      def entity_name(value)
+        @query_id = value
+      end
+
+      def query(sql_string = nil)
+        sql_string.nil? ? @query : @query = sql_string.strip
+      end
+
+      def server(config = nil)
+        if config.nil?
+          @server ||
+            if (superclass = ancestors[1]).respond_to?(:server)
+              superclass.server
+            else
+              nil
+            end
+        else
+          @server =
+            if config.is_a?(Hash)
+              Server.new(config)
+            else
+              config
+            end
+        end
+      end
+
+      def where(params, dry_run = false)
+        request = server.format_request(query_id, query, params)
+        if dry_run
+          request
+        else
+          data = server.run_query(server.build_request_body([request]))
+          data = data[0] if data.is_a?(Array)
+          Resultset.new(self, data)
+        end
+      end
+
+      def has_many(accessor_name, options)
+        foreign_class_name =
+          if options[:class_name].present?
+            options[:class_name]
+          else
+            accessor_name.to_s.singularize.camelize
+          end
+        # the query to run to get the data
+        association = -> (this, foreign_entity, join_attributes, dry_run) {
+          foreign_entity.where(Hash[ join_attributes.map do |attr_names|
+            attr_value =
+              if attr_names[1].is_a?(Symbol)
+                this.send(attr_names[1])
+              else
+                attr_names[1]
+              end
+            [ attr_names[0], attr_value ]
+          end ], dry_run)
+        }
+        # get the attributes to define the foreign scope
+        join_attributes = (options[:where] || []).to_a
+        # memoize the associated resultset
+        memoize_var = "@has_many_#{accessor_name}"
+        # define the accessor method
+        define_method(accessor_name) do |dry_run = false|
+          # get the associated entity class
+          foreign_entity = Module.const_get(foreign_class_name)
+          if dry_run
+            association.call(self, foreign_entity, join_attributes, true)
+          else
+            instance_variable_get(memoize_var) ||
+              instance_variable_set(memoize_var,
+                association.call(self, foreign_entity, join_attributes, false))
+          end
+        end
+        # define the setter method
+        define_method("#{accessor_name}=") do |array|
+          # get the associated entity class
+          foreign_entity = Module.const_get(foreign_class_name)
+          instance_variable_set(memoize_var,
+            Resultset.new(foreign_entity, array))
+        end
+        # save the newly created association
+        register_association(accessor_name)
+      end
+
+      def has_one(accessor_name, options)
+        plural_accessor_name = "s_#{accessor_name}".to_s.pluralize
+        class_name = accessor_name.to_s.camelize
+        has_many(plural_accessor_name, { class_name: class_name }.merge(options))
+        define_method(accessor_name) do
+          send(plural_accessor_name).first
+        end
+      end
+
+      def registered_associations
+        @registered_associations || []
+      end
+
+    private
+
+      def register_association(association_name)
+        @registered_associations ||= []
+        @registered_associations << association_name.to_sym
+      end
+    end # class << self
+
+    def get_association_requests
+      self.class.registered_associations.map do |a_name|
+        send(a_name, true)
+      end
+    end
+
+    def set_associations_data(associations_data)
+      self.class.registered_associations.map.with_index do |a_name, i|
+        send("#{a_name}=", associations_data[i])
+      end
+    end
+
+    def get_associations
+      self.class.registered_associations.map do |a_name|
+        send(a_name)
+      end
+    end
+
+    def build_associations(max_depth = false)
+      Resultset.new(self.class, [self]).build_associations(max_depth)
+    end
+
+    def to_h
+      @_to_h ||=
+        Hash[ attribute_names.map { |a_name| [a_name, send(a_name)] } ]
+    end
+
+  end # class Entity
+end

data/lib/sqlcached_client/hash_struct.rb

@@ -0,0 +1,70 @@
+module SqlcachedClient
+  # Maps recursively hashes into objects with lazy evaluation. For example
+  #
+  #  hs = HashStruct.new({
+  #    a: ['foo', { a1: [{ a2: 'one' }, 'two', 'three'] }, 'bar'],
+  #    b: 'baz',
+  #    c: 4,
+  #    d: { d1: { d2: { d3: 'hi' } } }
+  #  })
+  #    # => #<HashStruct:0x0000000f188008>
+  #
+  #  hs.b
+  #    # => "baz"
+  #
+  #  hs.c
+  #    # => 4
+  #
+  #  hs.a
+  #    # => ["foo", #<HashStruct:0x0000000f1dc798>, "bar"]
+  #
+  #  hs.a[1].a1
+  #    # => [#<HashStruct:0x0000000f275ce0>, "two", "three"]
+  #
+  #  hs.a[1].a1[0].a2
+  #    # => "one"
+  #
+  #  # values are memoized
+  #  hs
+  #    # => #<HashStruct:0x0000000f188008
+  #    #  @_a=["foo", #<HashStruct:0x0000000f1dc798 @_a1=[#<HashStruct:0x0000000f275ce0 @_a2="one">, "two", "three"]>, "bar"],
+  #    #  @_b="baz",
+  #    #  @_c=4>
+  class HashStruct
+
+    def initialize(hash)
+      hash.each do |key, value|
+        define_singleton_method(key.to_sym, &HashStruct.build(value, key))
+      end
+    end
+
+    class << self
+
+      # @return [Proc]
+      def build(value, accessor_name = nil)
+        lambda =
+          if value.is_a?(Hash)
+            -> (aself, value) { HashStruct.new(value) }
+          elsif value.is_a?(Array)
+            -> (aself, value) {
+              value.map { |item| aself.instance_eval(&HashStruct.build(item)) }
+            }
+          else
+            -> (aself, value) { value }
+          end
+        if !accessor_name.nil?
+          memoize_v = "@_#{accessor_name}"
+          Proc.new {
+            if instance_variable_defined?(memoize_v)
+              instance_variable_get(memoize_v)
+            else
+              instance_variable_set(memoize_v, lambda.call(self, value))
+            end
+          }
+        else
+          Proc.new { lambda.call(self, value) }
+        end
+      end
+    end # class << self
+  end # class HashStruct
+end

data/lib/sqlcached_client/resultset.rb

@@ -0,0 +1,73 @@
+module SqlcachedClient
+  class Resultset
+    include Enumerable
+
+    attr_reader :entity_class, :entities, :count
+
+    # @param entity_class [Class]
+    # @param entities [Array]
+    def initialize(entity_class, entities)
+      @entity_class = entity_class
+      @entities = (entities || []).map do |item|
+        if item.is_a?(Hash)
+          entity_class.new(item)
+        elsif item.is_a?(entity_class)
+          item
+        else
+          raise "Cannot handle instances of #{item.class.name}"
+        end
+      end
+      @count = @entities.size
+    end
+
+    class << self
+
+      def build_associations(resultsets, server, max_depth, current_depth = 0)
+        if resultsets.any?
+          batch = resultsets.map { |r| r._get_entities_association_requests }
+          if batch.flatten.any?
+            next_batch =
+              server.run_query(
+                server.build_request_body(
+                  batch
+                )
+              ).map.with_index do |resultset_data, i|
+                resultsets[i]._fill_associations(resultset_data)
+              end.flatten!
+            if !max_depth || current_depth < max_depth
+              build_associations(next_batch, server, max_depth, current_depth + 1)
+            end
+          end
+        end
+      end
+    end # class << self
+
+    def each(&block)
+      block ? entities.each(&block) : entities.each
+    end
+
+    def [](i)
+      entities[i]
+    end
+
+    def uncache
+      # TODO
+    end
+
+    def build_associations(max_depth = false)
+      self.class.build_associations([self], entity_class.server, max_depth)
+    end
+
+    def _fill_associations(data)
+      data.map.with_index do |entity_assoc_data, i|
+        entities[i].set_associations_data(entity_assoc_data)
+      end
+    end
+
+    def _get_entities_association_requests
+      entities.map do |entity|
+        entity.get_association_requests
+      end
+    end
+  end
+end

data/lib/sqlcached_client/server.rb

@@ -0,0 +1,76 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module SqlcachedClient
+  class Server
+    attr_reader :host, :port
+
+    def initialize(config)
+      @host = config[:host]
+      @port = config[:port]
+    end
+
+
+    def run_query(http_req_body)
+      url = server_url
+      Net::HTTP.start(url.host, url.port) do |http|
+        req = Net::HTTP::Post.new(data_batch_url)
+        req.set_content_type('application/json')
+        req.body = http_req_body.to_json
+        resp = http.request(req)
+        if 'application/json' == resp['Content-Type']
+          resp_body = parse_response_body(JSON.parse(resp.body))
+        else
+          resp_body = resp.body
+        end
+        if 200 == resp.code.to_i
+          resp_body
+        else
+          raise "Got http response #{resp.code} from server - #{resp_body.inspect}"
+        end
+      end
+    end
+
+
+    def parse_response_body(body)
+      if body.is_a?(Array)
+        body.map { |item| parse_response_body(item) }
+      elsif body.is_a?(Hash)
+        if (resultset = body['resultset']).is_a?(String)
+          JSON.parse(resultset)
+        else
+          resultset
+        end
+      else
+        body
+      end
+    end
+
+
+    def build_request_body(ary)
+      { batch: ary }
+    end
+
+
+    def format_request(query_id, query_template, params)
+      {
+        queryId: query_id,
+        queryTemplate: query_template,
+        queryParams: params
+      }
+    end
+
+  private
+
+    def server_url
+      URI("http://#{host}:#{port}")
+    end
+
+    def data_batch_url
+      url = server_url
+      url.path = "/data-batch"
+      url
+    end
+  end
+end

data/lib/sqlcached_client/version.rb

@@ -0,0 +1,3 @@
+module SqlcachedClient
+  VERSION = "0.0.1"
+end

data/lib/sqlcached_client.rb

@@ -0,0 +1,5 @@
+require 'active_support'
+require 'active_support/core_ext/string'
+
+require 'sqlcached_client/version'
+require 'sqlcached_client/entity'

data/spec/sqlcached_client/hash_struct_spec.rb

@@ -0,0 +1,26 @@
+require 'sqlcached_client/hash_struct'
+
+RSpec.describe SqlcachedClient::HashStruct do
+  let(:hash_struct) do
+    SqlcachedClient::HashStruct.new({
+      a: ['foo', { a1: [{ a2: 'one' }, 'two', 'three'] }, 'bar'],
+      b: 'baz',
+      c: 4,
+      d: { d1: { d2: { d3: 'hi' } } }
+    })
+  end
+
+  it "should map keys into methods" do
+    [:a, :b, :c, :d].each do |m|
+      expect(hash_struct.respond_to?(m)).to eq(true)
+    end
+  end
+
+  it "should map recoursively" do
+    ary = hash_struct.a
+    expect(ary[0]).to eq('foo')
+    expect(ary[1].a1[0].a2).to eq('one')
+    expect(hash_struct.d.d1.d2.d3).to eq('hi')
+    expect(hash_struct.c).to eq(4)
+  end
+end

data/sqlcached_client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sqlcached_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sqlcached_client"
+  spec.version       = SqlcachedClient::VERSION
+  spec.authors       = ["Roberto Maestroni"]
+  spec.email         = ["r.maestroni@gmail.com"]
+  spec.summary       = %q{A Ruby client for sqlcached}
+  spec.description   = %q{A Ruby client for sqlcached}
+  spec.homepage      = "https://github.com/rmaestroni/sqlcached_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: sqlcached_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Roberto Maestroni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: A Ruby client for sqlcached
+email:
+- r.maestroni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sqlcached_client.rb
+- lib/sqlcached_client/entity.rb
+- lib/sqlcached_client/hash_struct.rb
+- lib/sqlcached_client/resultset.rb
+- lib/sqlcached_client/server.rb
+- lib/sqlcached_client/version.rb
+- spec/sqlcached_client/hash_struct_spec.rb
+- sqlcached_client.gemspec
+homepage: https://github.com/rmaestroni/sqlcached_client
+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.2
+signing_key: 
+specification_version: 4
+summary: A Ruby client for sqlcached
+test_files:
+- spec/sqlcached_client/hash_struct_spec.rb