atomsphere 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23cc0ef0dd56bb090f6bacf78d916d24ca0f394758d8e8ce13108a7b2eea64c6
-  data.tar.gz: e5a9a93b5ae8483ac6d84ffb06253d11190204d945b0cd14880ec5941b016837
+  metadata.gz: c31438d4c2d2f7684ed44f1cfac54cd5077b186b140c46a9f99fa39a52f1ac66
+  data.tar.gz: 79c7d6193080ea557c9ba8498c5b167f5837a00346aa68641d4bbaa9104adfb2
 SHA512:
-  metadata.gz: ef9ac935360e5106205ac3ec02b04c55d6fc113c578257ac18abd0817309e811409205406c2728bde48e9e48df3bbc412ce0fa83d782686e37d24542ab3e0614
-  data.tar.gz: 2321d78c1730c279adf5e5a1975feb91acd5479c05b1bac281077a7d858169eb464e407e5b06997cbf5112c10eb79f9527e8c9c2bb7084c6f40292b2f161b927
+  metadata.gz: 46918892bdb5c7d815657b71ff3c499bbf264dae88ea7b7c2bb8ea95cf4aded55df373d5e6fb40c67c76594bf4039576540b07393894a6644c43bfb02f032b39
+  data.tar.gz: 1f997e4482a3af6c93880f2328151f2702b105e637a15571561ccec218b35a9a983bab678ccebeaa70093ad02e598cc24800700b0e6dde27b3cb82851359e6b8

data/README.md

@@ -44,29 +44,21 @@ Alternatively, environment variables may be used:
 
 ### Querying
 
-Generate a query for all _"Processes"_ that start with _"Production"_ and
-contain _"NetSuite"_ or _"Salesforce"_:
+Using the query builder:
 
 ```ruby
-query = Atomsphere.query('Process') do
-  group :and do
-    name.like 'Production%'
-    group :or do
-      name.like '%NetSuite%'
-      name.like '%Salesforce%'
+query = Atomsphere.query(:atom) do
+  group :or do
+    date_installed.less_than '2018-12-01T00:00:00Z'
+    group :and do
+      status.not_equals :online
+      type.not_equals :cloud
     end
   end
 end
 ```
 
-Generate a query for all online Atoms:
-
-```ruby
-query = Atomsphere.query('Atom') do
-  status.equals 'ONLINE'
-  type.equals   'CLOUD'
-end
-```
+See more examples at https://www.rubydoc.info/gems/atomsphere/Atomsphere.query
 
 Inspect the query filter:
 

data/atomsphere.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'atomsphere'
-  s.version       = '0.1.10'
+  s.version       = '0.1.11'
   s.licenses      = ['MIT']
   s.summary       = "Unofficial Ruby client for the Dell Boomi Atomsphere API"
   s.authors       = ["Warren Guy"]

data/lib/atomsphere.rb

@@ -1,6 +1,6 @@
 # @author Warren Guy
 module Atomsphere
-  VERSION = '0.1.10'
+  VERSION = '0.1.11'
   ROOT = "#{File.expand_path(__dir__)}/atomsphere"
 
   %w(configuration query api action).each{ |m| require "#{ROOT}/#{m}" }

data/lib/atomsphere/query.rb

@@ -1,3 +1,6 @@
+require 'facets/string/camelcase'
+require 'facets/string/snakecase'
+
 module Atomsphere
 
   # @attr         [String]               object_type   name of the object to query
@@ -17,6 +20,8 @@ module Atomsphere
       case params
       when String
         params = {object_type: params}
+      when Symbol
+        params = {object_type: params.to_s.upper_camelcase}
       end
 
       params = {

data/lib/atomsphere/query/builder.rb

@@ -1,5 +1,9 @@
 module Atomsphere
   class Query
+
+    # DSL for onstructing an {Atomsphere::Query}
+    # @see Atomsphere#query
+    # @attr_reader [Atomsphere::Query] query output query object
     class Builder
       attr_reader :query
 
@@ -7,6 +11,9 @@ module Atomsphere
         @query = object_type.nil? ? Query.new : Query.new(object_type)
       end
 
+      # Define a {GroupingExpression} at the top level of the query. If called
+      # more than once, subsequent calls create a grouping expression within
+      # the first created {GroupingExpression}.
       def group operator, &block
         new_group = GroupingExpression.new(operator)
         Group.new(new_group).instance_eval(&block)
@@ -18,6 +25,9 @@ module Atomsphere
         end
       end
 
+      # Allows for defining of {SimpleExpression}s at the top level of the
+      # query. Creates a top level {GroupingExpression} if none yet exists
+      # to contain it.
       def method_missing m, *args, &block
         @query.filter = GroupingExpression.new(:and) unless @query.filter
         Group.new(@query.filter).instance_eval do
@@ -27,6 +37,30 @@ module Atomsphere
     end
   end
 
+  # Invoke the DSL for constructing an {Atomsphere::Query}
+  #
+  # @example without an expression, returns all possible results
+  #   Atomsphere.query(:process)
+  #
+  # @example a simple query expression for online Atoms
+  #   Atomsphere.query(:atom) { status.equals :online }
+  #
+  # @example a query expression for online cloud Atoms (implied `and` group)
+  #   Atomsphere.query(:atom) do
+  #     status.equals :online
+  #     type.equals :cloud
+  #   end
+  #
+  # @example a more complex example with nested group expressions
+  #   Atomsphere.query(:atom) do
+  #     group :or do
+  #       date_installed.less_than '2018-12-01T00:00:00Z'
+  #       group :and do
+  #         status.not_equals :online
+  #         type.not_equals :cloud
+  #       end
+  #     end
+  #   end
   def self.query(object_type=nil, &block)
     q = Query::Builder.new(object_type)
     q.instance_eval(&block) if block_given?

data/lib/atomsphere/query/expression/simple_expression.rb

@@ -34,10 +34,24 @@ module Atomsphere
         }.merge(params)
 
         %w(operator property argument).each do |v|
-          instance_variable_set :"@#{v}", params[v.to_sym]
+          send :"#{v}=", params[v.to_sym]
         end
       end
 
+      def property= arg
+        instance_variable_set :@property,
+          case arg
+          when String
+            arg
+          when Symbol
+            arg.to_s.lower_camelcase
+          end
+      end
+
+      def argument= arg
+        instance_variable_set :@argument, arg.map(&:to_s)
+      end
+
       # run all `validate_*!` private methods to ensure validity of expression parameters
       # @return [true, false]
       def validate!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atomsphere
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Warren Guy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2019-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rotp