restforce-query 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f3b0b1326cc3430f270d4627d953a16504ab9785a3cb0d45a5f5374c1e9cdb6
+  data.tar.gz: 6fb031b51a294bae4ee48d6a962de7486e81d716b53c5fbe6a75f08c3d9d287d
+SHA512:
+  metadata.gz: 0efe646dcf43283e6ddfd51ff78774d497e89d1eab8ec2111bc8216c0f6dfe113f36de72299f3aa5c0481350fcd5df207a8d1602adcae2670a4dd1e473339b01
+  data.tar.gz: 129e01abc9caa4206f1b54b6c39df5da3a6a8d009265db0eeb5630a40b733d0362bc0f9f59b732bd0e63deacd58935b923ca6fa515dbedfd4d85d06fd87a7813

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in restforce-query.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    restforce-query (0.1.0)
+      restforce
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    faraday (0.15.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    hashie (3.5.7)
+    json (2.1.0)
+    multipart-post (2.0.0)
+    rake (10.5.0)
+    restforce (2.5.3)
+      faraday (>= 0.9.0, <= 1.0)
+      faraday_middleware (>= 0.8.8, <= 1.0)
+      hashie (>= 1.2.0, < 4.0)
+      json (>= 1.7.5)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  restforce-query!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,39 @@
+# Restforce::Query
+
+This gem provides a DSL for making restforce queries and avoid writing SOQL by hand.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'restforce-query'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restforce-query
+
+## Usage
+
+Example:
+```ruby
+Restforce::Query.select('LeadSource', 'COUNT(id)')
+                .from('Opportunity')
+                .where(StageName: 'Closed Won')
+                .group_by('LeadSource')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/santi698/restforce-query.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "restforce/query"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/restforce/query/builder.rb

@@ -0,0 +1,93 @@
+require_relative 'where_renderer'
+
+module Restforce
+  class Query
+    # Private class, used by Restforce::Query
+    class Builder
+      MAX_QUERY_SIZE = 20_000
+      QueryTooLargeError = StandardError.new("Maximum query size of #{MAX_QUERY_SIZE} exceeded")
+      def initialize
+        @fields = []
+        @tables = []
+        @custom_conditions = []
+        @conditions = {}
+        @groupings = []
+        @limit = nil
+        @distinct = false
+      end
+
+      def select(*fields)
+        @fields += (fields.flatten - @fields)
+        self
+      end
+
+      def select_distinct(*fields)
+        @fields += (fields.flatten - @fields)
+        @groupings += (fields.flatten - @groupings)
+        self
+      end
+
+      def distinct
+        @distinct = true
+        self
+      end
+
+      def from(*tables)
+        @tables = tables.flatten
+        self
+      end
+
+      def where(custom_condition = nil, **conditions)
+        @custom_conditions << "(#{custom_condition})" unless custom_condition.nil?
+        @conditions = @conditions.merge(conditions)
+        self
+      end
+
+      def group_by(*groupings)
+        @groupings += (groupings.flatten - @groupings)
+        self
+      end
+
+      def limit(lim)
+        @limit = lim
+        self
+      end
+
+      def render
+        raise 'There must be at least one field in the SELECT clause' if @fields.empty?
+        raise 'There must be at least one table in the FROM clause' if @tables.empty?
+        result = "#{render_select}#{render_from}#{render_where}#{render_group_by}#{render_limit}"
+        raise QueryTooLargeError if result.size > MAX_QUERY_SIZE
+        result.strip
+      end
+
+      alias to_s render
+
+      private
+
+      def render_select
+        "SELECT #{@fields.join(', ')}"
+      end
+
+      def render_from
+        " FROM #{@tables.join(', ')}"
+      end
+
+      def render_where
+        WhereRenderer.render(@custom_conditions, @conditions)
+      end
+
+      def render_group_by
+        # This line adds all fields in the select which were not explicitly grouped
+        @groupings += (@fields - @groupings) if @distinct
+        return '' if @groupings.empty?
+        " GROUP BY #{@groupings.join(', ')}"
+      end
+
+      def render_limit
+        return '' if @limit.nil?
+        " LIMIT #{@limit}"
+      end
+    end
+  end
+end

data/lib/restforce/query/version.rb

@@ -0,0 +1,5 @@
+module Restforce
+  class Query
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/restforce/query/where_renderer.rb

@@ -0,0 +1,54 @@
+module Restforce
+  class Query
+    # Private class, used by Restforce::Query
+    class WhereRenderer
+      MAX_WHERE_SIZE = 12_000
+      WhereTooLargeError = StandardError.new("Maximum WHERE size of #{MAX_WHERE_SIZE} exceeded")
+      def initialize(custom_conditions, conditions)
+        @custom_conditions = custom_conditions || []
+        @conditions = conditions || []
+      end
+
+      def self.render(custom_conditions, conditions)
+        new(custom_conditions, conditions).render
+      end
+
+      def render
+        conditions_text = render_custom + render_connector + render_conditions
+        return '' if conditions_text.strip.size.zero?
+        result = " WHERE #{conditions_text}"
+        raise WhereTooLargeError if result.size > MAX_WHERE_SIZE
+        result
+      end
+
+      private
+
+      def render_conditions
+        return '' if @conditions.count.zero?
+        @conditions.map do |k, v|
+          next "#{k} IN #{render_list(v)}" if v.is_a? Enumerable
+          next "#{k} = NULL" if v.nil?
+          "#{k} = #{render_item(v)}"
+        end.join(' AND ')
+      end
+
+      def render_connector
+        (@conditions.count > 0) && (@custom_conditions.count > 0)? ' AND ' : ''
+      end
+
+      def render_custom
+        return '' if @custom_conditions.count.zero?
+        @custom_conditions.join(' AND ')
+      end
+
+      def render_list(*items)
+        "(#{items.flatten.map { |i| render_item(i) }.join(',')})"
+      end
+
+      def render_item(item)
+        return "'#{item}'" if item.is_a? String
+        item
+      end
+    end
+  end
+end

data/lib/restforce/query.rb

@@ -0,0 +1,47 @@
+require 'restforce'
+require 'restforce/query/version'
+require 'restforce/query/builder'
+require 'restforce/query/where_renderer'
+
+module Restforce
+  # This is the main entry point for starting a query
+  # Chain calls to: select, where, distinct, from, group_by, limit or select_distinct to use it
+  class Query
+    include Enumerable
+    def initialize(query_builder = Builder.new)
+      @query_builder = query_builder
+      @salesforce = Restforce.new
+    end
+
+    %i[select select_distinct distinct where from group_by limit].each do |method_name|
+      # Defines instance methods and returns self to enable chaining
+      define_method(method_name) do |*params|
+        @query_builder.send(method_name, *params)
+        # Flush cache results each time the query is modified
+        @results = nil
+        self
+      end
+      # Defines class methods for easy access. i.e.: SalesforceQuery.where(...)
+      define_singleton_method(method_name) do |*params|
+        new.send(method_name, *params)
+      end
+    end
+
+    def execute
+      return @results if @results.present?
+      query = @query_builder.to_s
+      Rails.logger.debug(query)
+      @results = @salesforce.query(query)
+    end
+
+    def each
+      execute
+    end
+
+    def find
+      @query_builder.limit(1)
+      execute
+      @results.first
+    end
+  end
+end

data/restforce-query.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restforce/query/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'restforce-query'
+  spec.version       = Restforce::Query::VERSION
+  spec.authors       = ['Santiago Ocamica']
+  spec.email         = ['santi6982@gmail.com']
+
+  spec.summary       = 'A Query DSL for Restforce'
+  spec.homepage      = 'https://github.com/santi698/restforce-query'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'restforce'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: restforce-query
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Santiago Ocamica
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: restforce
+  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'
+description: 
+email:
+- santi6982@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/restforce/query.rb
+- lib/restforce/query/builder.rb
+- lib/restforce/query/version.rb
+- lib/restforce/query/where_renderer.rb
+- restforce-query.gemspec
+homepage: https://github.com/santi698/restforce-query
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A Query DSL for Restforce
+test_files: []