civicrm 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbe6f59cb6fc11c4e85ca5073ef1c6ef1e66abb0
-  data.tar.gz: 14a8dde7bd765bb9c7d98275b9fc6313ffb52867
+  metadata.gz: 7cfa1149476a5896453ceb5b9a1338e8086179c8
+  data.tar.gz: f816b49e711481291aa6f747b7cf073108e580c2
 SHA512:
-  metadata.gz: b35e8244019544a13e2f78b9815ac5cdf631e708f8cfa4ddd2c5053a37fa435b7eef42f9d545ebcf873b22a55b6072502b3a5e09ebabccd7b07739b0ec684205
-  data.tar.gz: a52d8f160cf41f3b6f49d4581d825d63a56de7b9153bf42921b77e039f41ef4b12349733cf41c84e10a49fa0eb3ae44518d5454c797ac61aad9ae51b6d490bdf
+  metadata.gz: 722be9f5dc41b116331dad7d1d198141d210176e47c457aaec892b994d08b90156204978acc93d90e633c336c8f1e05a05e08d72ea66e7d5451115c0080af061
+  data.tar.gz: 51764fa77039ef8e06f3b0e85be14976ae4c96df8dce4c052f44d60e4a280d69bcb50b03551ee087e50583fa781406503057fb1f9bb130fd82c069110eeae4e1

data/.gitignore

@@ -1,2 +1,4 @@
 /pkg
 .rvmrc
+.byebug_history
+*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    civicrm (1.0.4)
+    civicrm (1.0.5)
       activemodel
       activesupport
       nokogiri
@@ -10,27 +10,29 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.0)
-      activesupport (= 5.2.0)
-    activesupport (5.2.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
+    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)
       minitest (~> 5.1)
+      thread_safe (~> 0.1)
       tzinfo (~> 1.1)
+    builder (3.2.3)
+    byebug (10.0.2)
     concurrent-ruby (1.0.5)
-    diff-lcs (1.2.1)
+    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 (1.0.1)
+    i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    metaclass (0.0.1)
+    json (1.8.6)
     mime-types (2.99.3)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
-    mocha (0.10.5)
-      metaclass (~> 0.0.1)
     netrc (0.11.0)
     nokogiri (1.8.4)
       mini_portile2 (~> 2.3.0)
@@ -39,14 +41,19 @@ GEM
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
@@ -58,10 +65,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
   civicrm!
-  mocha
   rake
-  rspec
+  rspec (~> 3.8)
 
 BUNDLED WITH
    1.12.5

data/README.md

@@ -1,31 +1,49 @@
+# CiviCRM Client
+
 ## Installation
 
-* $ gem install civicrm
+```
+$ gem install civicrm
+```
 
 ## Getting started
 
 ```ruby
-* CiviCrm.site_key = 'YOUR_SITE_KEY'
-* // More info about site_key:
-* // http://wiki.civicrm.org/confluence/display/CRMDOC43/Managing+Scheduled+Jobs
-* CiviCrm.api_base = 'https://www.example.org/path/to/civi/codebase/'
-* CiviCrm.authenticate('demo', 'demo')
+# 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 = "..."
 ```
 
 ## CiviCrm Objects
 
 ```ruby
-* CiviCrm::Contact.all    # get list of contacts
-* CiviCrm::Contact.create(contact_type: 'Organization', organization_name: 'test') # create contact
-* CiviCrm::Contact.find(1).delete      # find and delete
+# Get list of contacts
+CiviCrm::Contact.all
+
+# Create contact
+CiviCrm::Contact.create(contact_type: "Organization", organization_name: "test")
+
+# Find and delete
+CiviCrm::Contact.find(1).delete
 ```
 
 ## Testing
+
 ```
-rspec spec
+$ bundle exec rspec spec
 ```
 
 ## Useful links
 
-* http://wiki.civicrm.org/confluence/display/CRMDOC43/REST+interface
-* http://drupal.demo.civicrm.org/civicrm/api/explorer
+* https://docs.civicrm.org/dev/en/latest/api/interfaces/#rest-interface
+* http://drupal.demo.civicrm.org/civicrm/api/explorer
+
+## Acknowledgements
+
+Created by [Iskander Haziev](https://github.com/gvalmon). Maintained by [EFF](https://www.eff.org/).

data/civicrm.gemspec

@@ -19,8 +19,8 @@ spec = Gem::Specification.new do |s|
   s.add_dependency('nokogiri')
 
   s.add_development_dependency('rake')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('mocha')
+  s.add_development_dependency('rspec', '~> 3.8')
+  s.add_development_dependency('byebug')
 
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")

data/lib/civicrm/version.rb

@@ -1,3 +1,3 @@
 module CiviCrm
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

data/lib/civicrm/xml.rb

@@ -2,13 +2,12 @@ module CiviCrm
   class XML
     class << self
       def parse(text)
-        # CiviCRM <Result>s sometimes contain weird elements
+        # CiviCRM <Result>s sometimes contain invalid elements
         # like <preferred_communication_method><0></0></ ...
-        # that Nokogiri::XML can't hang with. Get rid of them before
-        # parsing.
+        # Get rid of them before parsing.
         fixed_text = text.to_s.
                      gsub("\n", "").
-                     gsub(/<(\w|_)+>\s*<\d+><\/\d+>\s*<\/(\w|_)+>/, "")
+                     gsub(/<\d+>(.*?)<\/\d+>/, "")
 
         doc = Nokogiri::XML.parse(fixed_text)
 

data/spec/requests/base_spec.rb

@@ -1,62 +1,61 @@
 require 'spec_helper'
 require 'rest_client'
 require 'ostruct'
+
 describe "API Bindings" do
 
-  before :all do
-    @client = authorized_civicrm_client
-  end
+  let(:client){ authorized_civicrm_client }
 
   it "should not fetch from network while initializing a new Resource" do
-    @client.expects(:get).never
+    expect(client).not_to receive(:get)
     CiviCrm::Contact.new(id: "someid")
   end
 
   it "should run authentication" do
-    @client.expects(:post).once.returns(test_response(api_key: 'test'))
+    expect(client).
+      to receive(:post).
+          exactly(:once).
+          and_return(test_response(api_key: 'test'))
+
     CiviCrm.authenticate("test", "test")
   end
 
   describe "exception handler" do
-
-    before :all do
-      @client = CiviCrm::Client
-    end
+    let(:client){ CiviCrm::Client }
 
     it "should raise CiviCrm::Errors::BadRequest on 400" do
-      exception = RestClient::Exception.new(OpenStruct.new(code: 400, body: 'message'))
-      RestClient::Request.stubs(:execute).raises(exception)
-      expect { @client.execute!({}) }.to raise_error(CiviCrm::Errors::BadRequest)
+      exception = RestClient::Exception.new(nil, 400)
+      expect(RestClient::Request).to receive(:execute).and_raise(exception)
+      expect { client.execute!({}) }.to raise_error(CiviCrm::Errors::BadRequest)
     end
 
     it "should raise CiviCrm::Errors::Unauthorized on 401" do
-      exception = RestClient::Exception.new(OpenStruct.new(code: 401, body: 'message'))
-      RestClient::Request.stubs(:execute).raises(exception)
-      expect { @client.execute!({}) }.to raise_error(CiviCrm::Errors::Unauthorized)
+      exception = RestClient::Exception.new(nil, 401)
+      expect(RestClient::Request).to receive(:execute).and_raise(exception)
+      expect { client.execute!({}) }.to raise_error(CiviCrm::Errors::Unauthorized)
     end
 
     it "should raise CiviCrm::Errors::Forbidden on 403" do
-      exception = RestClient::Exception.new(OpenStruct.new(code: 403, body: 'message'))
-      RestClient::Request.stubs(:execute).raises(exception)
-      expect { @client.execute!({}) }.to raise_error(CiviCrm::Errors::Forbidden)
+      exception = RestClient::Exception.new(nil, 403)
+      expect(RestClient::Request).to receive(:execute).and_raise(exception)
+      expect { client.execute!({}) }.to raise_error(CiviCrm::Errors::Forbidden)
     end
 
     it "should raise CiviCrm::Errors::NotFound on 404" do
-      exception = RestClient::Exception.new(OpenStruct.new(code: 404, body: 'message'))
-      RestClient::Request.stubs(:execute).raises(exception)
-      expect { @client.execute!({}) }.to raise_error(CiviCrm::Errors::NotFound)
+      exception = RestClient::Exception.new(nil, 404)
+      expect(RestClient::Request).to receive(:execute).and_raise(exception)
+      expect { client.execute!({}) }.to raise_error(CiviCrm::Errors::NotFound)
     end
 
     it "should raise CiviCrm::Errors::InternalError on 500" do
-      exception = RestClient::Exception.new(OpenStruct.new(code: 500, body: 'message'))
-      RestClient::Request.stubs(:execute).raises(exception)
-      expect { @client.execute!({}) }.to raise_error(CiviCrm::Errors::InternalError)
+      exception = RestClient::Exception.new(nil, 500)
+      expect(RestClient::Request).to receive(:execute).and_raise(exception)
+      expect { client.execute!({}) }.to raise_error(CiviCrm::Errors::InternalError)
     end
 
     it "should raise CiviCrm::Errors::Unauthorized if site_key is not provided" do
       CiviCrm.site_key = nil
-      RestClient::Request.stubs(:execute).returns('test')
-      expect { @client.request('get', 'test') }.to raise_error(CiviCrm::Errors::Unauthorized)
+      expect { client.request('get', 'test') }.to raise_error(CiviCrm::Errors::Unauthorized)
     end
   end
-end
+end

data/spec/resources/contact_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+
 describe CiviCrm::Contact do
   it { should be_listable_resource }
   #it { should be_updatable_resource }
@@ -6,8 +7,11 @@ describe CiviCrm::Contact do
   it "should return contact on create" do
     client = authorized_civicrm_client
 
-    client.expects(:post).once.returns(test_response(test_contact))
-    c = CiviCrm::Contact.create
-    c.should be_a_kind_of(CiviCrm::Contact)
+    expect(client).
+      to receive(:post).
+          exactly(:once).
+          and_return(test_response(test_contact))
+
+    expect(CiviCrm::Contact.create).to be_a_kind_of(CiviCrm::Contact)
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,18 @@
+require 'byebug'
+
 require 'civicrm'
 require 'support/civicrm'
 require 'support/civicrm_responses'
 require 'support/test_matchers'
+
 RSpec.configure do |config|
   include CiviCrm::TestResponses
-  config.mock_with :mocha
-end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+end

data/spec/support/civicrm.rb

@@ -20,8 +20,9 @@ module CiviCrm
     end
   end
 end
+
 def authorized_civicrm_client
   CiviCrm.api_key = 'civicrm'
   CiviCrm.site_key = 'civicrm'
-  CiviCrm::Client.mock_rest_client(mock)
-end
+  CiviCrm::Client.mock_rest_client(double)
+end

data/spec/support/civicrm_responses.rb

@@ -1,11 +1,7 @@
  module CiviCrm::TestResponses
   def test_response(body, code = 200)
     body = CiviCrm::XML.encode(body) if !(body.kind_of? String)
-    m = mock
-    m.instance_variable_set('@data', { body: body, code: code})
-    def m.body; @data[:body]; end
-    def m.code; @data[:code]; end
-    m
+    double(body: body, code: code)
   end
 
   def test_contact(params = {})
@@ -28,4 +24,4 @@
       :values => [test_contact, test_contact, test_contact]
     }
   end
-end
+end

data/spec/support/test_matchers.rb

@@ -4,34 +4,55 @@ RSpec::Matchers.define :be_listable_resource do |expected|
     subject = actual.class
     test_response_hash = send(:"test_#{subject.name.demodulize.underscore}_array")
 
-    client.expects(:get).once.returns(test_response(test_response_hash))
-    c = subject.all
+    expect(client).
+      to receive(:get).
+          exactly(:once).
+          and_return(test_response(test_response_hash))
 
-    c.should be_a_kind_of(Array)
+    expect(subject.all).to be_a_kind_of(Array)
   end
 end
+
 RSpec::Matchers.define :be_updatable_resource do |expected|
   match do |actual|
     client = authorized_civicrm_client
     subject = actual.class
 
-    client.expects(:get).once.returns(test_response(test_contact({name: "foo"})))
-    client.expects(:put).once.returns(test_response(test_contact({name: "bar"})))
+    expect(client).
+      to receive(:get).
+          exactly(:once).
+          and_return(test_response(test_contact({name: "foo"})))
+
+    expect(client).
+      to receive(:put).
+          exactly(:once).
+          and_return(test_response(test_contact({name: "bar"})))
+
     c = subject.find("resource_id")
-    c.name.should == "foo"
+    expect(c.name).to eq("foo")
+
     c.name = "bar"
     c.save
-    c.name.should == "bar"
+    expect(c.name).to eq("bar")
   end
 end
+
 RSpec::Matchers.define :be_deleteable_resource do |expected|
   match do |actual|
     client = authorized_civicrm_client
     subject = actual.class
 
-    client.expects(:get).once.returns(test_response(test_contact({name: "foo"})))
-    client.expects(:delete).once.returns(test_response(test_contact({name: "bar"})))
+    expect(client).
+      to receive(:get).
+          exactly(:once).
+          and_return(test_response(test_contact({name: "foo"})))
+
+    expect(client).
+      to receive(:delete).
+          exactly(:once).
+          and_return(test_response(test_contact({name: "bar"})))
+
     c = subject.find("resource_id")
     c.delete
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: civicrm
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Iskander Haziev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-27 00:00:00.000000000 Z
+date: 2018-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -84,18 +84,18 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="