civicrm 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fef486cc306da297b9010ca9d025559f42d7c66
-  data.tar.gz: 2ed02b63e766f9c26662199f991e9ed036cf9fa5
+  metadata.gz: 0b324b4218b63ab0e45d5d97f6524a4352bc34d9
+  data.tar.gz: db21f89583ef7ad9d9f05b25316569f11f0147d9
 SHA512:
-  metadata.gz: 5f11702c08be0bed68b271de6397f37f3080086bce413e56e8c8bd2e2f412ab6df57c1342da3cca8a2935906ec533bc85a9f7a15b32f71667473ca18b3fd3220
-  data.tar.gz: 1f2136ec2723933ced104de99c7ec9b626a71eb500c20cb0e00a5ea105e77cdb69e521338f9102b07cf9d41cad19caa777c104463cd467d59b540c27e75282db
+  metadata.gz: 351a3d9c51988a98df4df75b8e40c575af6845bf6f256a3db12443a6c9ab01a617e70edde104bf04e130df601471ba87d81a37b3c63f9bbaea1f0a56af26d137
+  data.tar.gz: 84c42c92bbe8e32fde0730eacd101f64192635fb06b3a1c7faeda9b14d86748aadc25dec951c9da14710ddb5b9b97ab6a74453ff3a03529c254f7db0099cc98a

data/Gemfile.lock

@@ -1,46 +1,44 @@
 PATH
   remote: .
   specs:
-    civicrm (1.0.5)
+    civicrm (1.1.1)
       activemodel
       activesupport
       nokogiri
-      rest-client (~> 1.4)
+      rest-client (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.1.16)
-      activesupport (= 4.1.16)
-      builder (~> 3.1)
-    activesupport (4.1.16)
-      i18n (~> 0.6, >= 0.6.9)
-      json (~> 1.7, >= 1.7.7)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
-      thread_safe (~> 0.1)
       tzinfo (~> 1.1)
-    builder (3.2.3)
     byebug (10.0.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.4)
     diff-lcs (1.3)
     domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    i18n (0.9.5)
+    i18n (1.1.1)
       concurrent-ruby (~> 1.0)
-    json (1.8.6)
-    mime-types (2.99.3)
-    mini_portile2 (2.3.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
     netrc (0.11.0)
-    nokogiri (1.8.4)
-      mini_portile2 (~> 2.3.0)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
     rake (10.0.3)
-    rest-client (1.8.0)
+    rest-client (2.0.2)
       http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)

data/README.md

@@ -12,11 +12,6 @@ $ gem install civicrm
 # Required config
 CiviCrm.api_base = "https://www.example.org/path/to/civi/codebase/"
 CiviCrm.site_key = "YOUR_SITE_KEY"
-
-# Authenticate with username/password
-CiviCrm.authenticate("username", "password")
-
-# OR, authenticate with API key
 CiviCrm.api_key = "..."
 ```
 

data/civicrm.gemspec

@@ -13,7 +13,7 @@ spec = Gem::Specification.new do |s|
   s.executables = 'civicrm'
   s.require_paths = %w{lib}
 
-  s.add_dependency('rest-client', '~> 1.4')
+  s.add_dependency('rest-client', '~> 2.0')
   s.add_dependency('activesupport')
   s.add_dependency('activemodel')
   s.add_dependency('nokogiri')

data/lib/civicrm.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 require 'active_support/deprecation'
 require 'active_support/core_ext/module'
 require 'active_support/core_ext/hash'
@@ -7,7 +9,6 @@ require 'nokogiri'
 
 # utils
 require 'civicrm/client'
-require 'civicrm/xml'
 require 'civicrm/resource'
 require 'civicrm/profiling'
 require 'civicrm/version'
@@ -34,7 +35,6 @@ module CiviCrm
   @@site_key = nil
   @@api_base = 'https://www.example.org/path/to/civi/codebase'
   @@api_version = 'v3'
-  @@user_authenticated = false
 
   mattr_accessor :api_key, :api_base, :api_version, :site_key
 
@@ -45,11 +45,6 @@ module CiviCrm
     base
   end
 
-  def self.authenticate(name, password)
-    auth = Client.request(:post, q: 'civicrm/login', name: name, pass: password)
-    @@api_key = auth[0]['api_key']
-  end
-
   def self.api_key=(key)
     @@api_key = key
   end

data/lib/civicrm/actions/destroy.rb

@@ -7,8 +7,12 @@ module CiviCrm
           'action' => 'delete',
           'id' => id
         }
+
         response = CiviCrm::Client.request(:post, params)
-        refresh_from(response.first.to_hash)
+
+        if response < 1
+          raise Error, "Couldn't delete #{entity_class_name}##{id}"
+        end
       end
 
       def delete!
@@ -18,8 +22,12 @@ module CiviCrm
           'skip_undelete' => 1,
           'id' => id
         }
+
         response = CiviCrm::Client.request(:post, params)
-        refresh_from(response.first.to_hash)
+
+        if response < 1
+          raise Error, "Couldn't delete #{entity_class_name}##{id}"
+        end
       end
     end
   end

data/lib/civicrm/client.rb

@@ -5,27 +5,32 @@ module CiviCrm
       # Returns parsed class inherited from CiviCrm::Resource
       def request(method, params = {})
         unless CiviCrm.site_key
-          raise CiviCrm::Errors::Unauthorized, "Please specify CiviCrm.site_key"
+          raise CiviCrm::Errors::Unauthorized,
+                "Please specify CiviCrm.site_key"
         end
+
         headers = {
           :user_agent => "CiviCrm RubyClient/#{CiviCrm::VERSION}"
         }
 
         opts = {
-          :method => method,
+          :method => :post,
           :timeout => 80,
           :headers => headers
         }
 
-        # build params
-        case method.to_s.downcase.to_sym
-        when :get, :head, :delete
-          path = params.count > 0 ? stringify_params(params) : ''
-        else
-          opts[:payload] = stringify_params(params)
-        end
+        params = params.dup
+
+        entity = params.delete("entity")
+        raise ArgumentError, "params must include entity" unless entity
 
-        opts[:url] = CiviCrm.api_url(path)
+        action = params.delete("action")
+        raise ArgumentError, "params must include action" unless action
+
+        method = { entity: entity, action: action }.to_query
+
+        opts[:payload] = { json: JSON.dump(params) }
+        opts[:url] = CiviCrm.api_url(method)
 
         response = nil
 
@@ -33,16 +38,19 @@ module CiviCrm
           response = execute(opts)
         end
 
-        puts(JSON.dump(params)) if ENV["DEBUG_CIVICRM_REQUEST"]
+        puts(JSON.dump(opts)) if ENV["DEBUG_CIVICRM_REQUEST"]
         puts(response) if ENV["DEBUG_CIVICRM_RESPONSE"]
 
         body, code = response.body, response.code
 
-        CiviCrm::XML.parse(body).tap do |results|
-          Array(results).each do |res|
-            raise Error, res["error_message"] if res["is_error"] == "1"
-          end
+        parsed_response = JSON.parse(body)
+
+        if parsed_response["is_error"] == 1
+          raise Error, parsed_response["error_message"]
         end
+
+        values = parsed_response.fetch("values")
+        values.is_a?(Hash) ? values.values : values
       end
 
       def execute(opts)
@@ -63,23 +71,6 @@ module CiviCrm
           raise e
         end
       end
-
-      def uri_escape(key)
-        URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-      end
-
-      def flatten_params(params, parent_key = nil)
-        result = []
-        params.each do |key, value|
-          flatten_key = parent_key ? "#{parent_key}[#{uri_escape(key)}]" : uri_escape(key)
-          result += value.is_a?(Hash) ? flatten_params(value, flatten_key) : [[flatten_key, value]]
-        end
-        result
-      end
-
-      def stringify_params(params)
-        flatten_params(params).collect{|key, value| "#{key}=#{uri_escape(value)}"}.join('&')
-      end
     end
   end
 end

data/lib/civicrm/profiling.rb

@@ -1,3 +1,5 @@
+require "benchmark"
+
 module CiviCrm
   module Profiling
     extend ActiveSupport::Concern

data/lib/civicrm/version.rb

@@ -1,3 +1,3 @@
 module CiviCrm
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/spec/requests/base_spec.rb

@@ -7,19 +7,10 @@ describe "API Bindings" do
   let(:client){ authorized_civicrm_client }
 
   it "should not fetch from network while initializing a new Resource" do
-    expect(client).not_to receive(:get)
+    expect(client).not_to receive(:post)
     CiviCrm::Contact.new(id: "someid")
   end
 
-  it "should run authentication" do
-    expect(client).
-      to receive(:post).
-          exactly(:once).
-          and_return(test_response(api_key: 'test'))
-
-    CiviCrm.authenticate("test", "test")
-  end
-
   describe "exception handler" do
     let(:client){ CiviCrm::Client }
 

data/spec/support/civicrm_responses.rb

@@ -1,6 +1,6 @@
  module CiviCrm::TestResponses
   def test_response(body, code = 200)
-    body = CiviCrm::XML.encode(body) if !(body.kind_of? String)
+    body = JSON.dump(is_error: 0, values: [body]) if !(body.kind_of? String)
     double(body: body, code: code)
   end
 

data/spec/support/test_matchers.rb

@@ -5,7 +5,7 @@ RSpec::Matchers.define :be_listable_resource do |expected|
     test_response_hash = send(:"test_#{subject.name.demodulize.underscore}_array")
 
     expect(client).
-      to receive(:get).
+      to receive(:post).
           exactly(:once).
           and_return(test_response(test_response_hash))
 
@@ -19,7 +19,7 @@ RSpec::Matchers.define :be_updatable_resource do |expected|
     subject = actual.class
 
     expect(client).
-      to receive(:get).
+      to receive(:post).
           exactly(:once).
           and_return(test_response(test_contact({name: "foo"})))
 
@@ -43,12 +43,12 @@ RSpec::Matchers.define :be_deleteable_resource do |expected|
     subject = actual.class
 
     expect(client).
-      to receive(:get).
+      to receive(:post).
           exactly(:once).
           and_return(test_response(test_contact({name: "foo"})))
 
     expect(client).
-      to receive(:delete).
+      to receive(:post).
           exactly(:once).
           and_return(test_response(test_contact({name: "bar"})))
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: civicrm
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Iskander Haziev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-02 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +140,6 @@ files:
 - lib/civicrm/resource.rb
 - lib/civicrm/resources/base.rb
 - lib/civicrm/version.rb
-- lib/civicrm/xml.rb
 - spec/requests/base_spec.rb
 - spec/resources/contact_spec.rb
 - spec/spec_helper.rb

data/lib/civicrm/xml.rb

@@ -1,41 +0,0 @@
-module CiviCrm
-  class XML
-    class << self
-      def parse(text)
-        # CiviCRM <Result>s sometimes contain invalid elements
-        # like <preferred_communication_method><0></0></ ...
-        # Get rid of them before parsing.
-        fixed_text = text.to_s.
-                     gsub("\n", "").
-                     gsub(/<\d+>(.*?)<\/\d+>/, "")
-
-        doc = Nokogiri::XML.parse(fixed_text)
-
-        results = doc.xpath('//Result')
-        results.map do |result|
-          hash = {}
-          result.children.each do |attribute|
-            next unless attribute.is_a?(Nokogiri::XML::Element)
-            hash[attribute.name] = attribute.children[0].text rescue nil
-          end
-          hash
-        end
-      end
-      def encode(resources)
-        builder = Nokogiri::XML::Builder.new do |xml|
-          xml.ResultSet do
-            Array.wrap(resources).each do |resource|
-              attributes = resource.respond_to?(:attributes) ? resource.attributes : resource
-              xml.Result do
-                attributes.each do |key, value|
-                  xml.send key.to_sym, value
-                end
-              end
-            end
-          end
-        end
-        builder.to_xml
-      end
-    end
-  end
-end