wcc-arena 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00034fba0404c3acd477309cf2547603b1e24b4b
-  data.tar.gz: ab1b9a3ee1243b075ee8ae65f9ed8050dd2b2535
+  metadata.gz: 2f332ecdc7d123631926b3383fcdbf607989cdd3
+  data.tar.gz: 790880e61fd1bfc3abf2bcf8c61c9ef3cfcb78db
 SHA512:
-  metadata.gz: 270c2cf5f3dfeebf91b8d5629f5d675867058b8a01685382775ba8971eb5d00de6ccd20636f79bfd1161fa672c8ef0649904cbe57811707eea261c71eca7d14c
-  data.tar.gz: a6b66fe9ecdcc8f7390d0d8b040ca31310cfb43e9db4b1e0775f7ea1324b37a514cb1c23fcff480782027d29848750f26755c2cb9294380f34635f53cf74ce3b
+  metadata.gz: 438d6c6d9b334781bd583b382f069c1997413335d7ae4cee98f79821f605be9bf5e93dcf18af5a4777d723c8a1b9710b83afe4086be4e83c2b741095fb8a2a16
+  data.tar.gz: a3ddac097befccaee154543f668e5445831428b60de3006cfe29a794ff9be1a590784ab4d5ffb0a2885a87f3a1978c82eca425c7b672dabb3d9b47f92f9a203b

data/lib/wcc/arena/profile.rb

@@ -1,5 +1,6 @@
 require 'wcc/arena/profile_query'
 require 'wcc/arena/profile_member_save'
+require 'wcc/arena/single_profile_query'
 
 require 'wcc/arena/profile_member'
 

data/lib/wcc/arena/single_profile_query.rb

@@ -0,0 +1,25 @@
+module WCC::Arena
+  class SingleProfileQuery
+    attr_reader :session
+    attr_reader :profile_id
+
+    def initialize(args={})
+      @session = args.fetch(:session) { WCC::Arena.config.session }
+      @profile_id = args.fetch(:profile_id)
+    end
+
+    def call
+      Profile.new(response_profile_xml) if response_profile_xml
+    end
+
+    private
+
+    def response_profile_xml
+      query_response.xml.root.xpath("/Profile")[0]
+    end
+
+    def query_response
+      @response ||= session.get("profile/#{profile_id}")
+    end
+  end
+end

data/lib/wcc/arena/version.rb

@@ -1,5 +1,5 @@
 module WCC
   module Arena
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/spec/fixtures/profile.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
+  <Active>true</Active>
+  <ActiveBranch>true</ActiveBranch>
+  <ActiveMembers>31699</ActiveMembers>
+  <BlobLink/>
+  <CampusID>-1</CampusID>
+  <CampusName/>
+  <ChildProfilesLink>profile/3094/list</ChildProfilesLink>
+  <CreatedBy>bob</CreatedBy>
+  <DateCreated>2011-10-10T09:49:38.557</DateCreated>
+  <DateModified>2011-10-10T09:49:38.557</DateModified>
+  <DormantMembers>7626</DormantMembers>
+  <EndTime>1900-01-01T00:00:00</EndTime>
+  <Guid>a4ba0388-42ed-4a4c-a0a0-a78a28a75925</Guid>
+  <HierarchyLevel>-1</HierarchyLevel>
+  <MembersLink>profile/3094/member/list</MembersLink>
+  <ModifiedBy>bob</ModifiedBy>
+  <Name>Awesome</Name>
+  <Notes/>
+  <OrganizationID>1</OrganizationID>
+  <OwnerID>199659</OwnerID>
+  <OwnerLink>person/30766779-0332-493b-960c-af66936f97f3</OwnerLink>
+  <ParentProfileLink/>
+  <ProfileActiveMemberCount>2</ProfileActiveMemberCount>
+  <ProfileID>3094</ProfileID>
+  <ProfileMemberCount>3</ProfileMemberCount>
+  <ProfileTypeID>1</ProfileTypeID>
+  <ProfileTypeValue>Ministry</ProfileTypeValue>
+  <QualifierID>-1</QualifierID>
+  <QualifierValue>Unknown</QualifierValue>
+  <StartTime>1900-01-01T00:00:00</StartTime>
+  <Summary/>
+  <Title>Awesomingle</Title>
+  <TotalMembers>39325</TotalMembers>
+</Profile>

data/spec/wcc/arena/single_profile_query_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+RSpec.describe WCC::Arena::SingleProfileQuery do
+  include FixturesHelpers
+
+  subject { described_class.new(args) }
+  let(:args) {
+    {
+      session: double("session"),
+      profile_id: rand(100)
+    }
+  }
+
+  describe "#initialize" do
+    it "sets the session ivar" do
+      query = described_class.new(args)
+      expect(query.session).to eq(args[:session])
+    end
+
+    it "defaults session to global config value" do
+      args.delete(:session)
+      query = described_class.new(args)
+      expect(query.session).to eq(WCC::Arena.config.session)
+    end
+
+    it "requires a profile_id argument" do
+      args.delete(:profile_id)
+      expect { described_class.new(args) }.to raise_error(KeyError)
+    end
+  end
+
+  describe "#call" do
+    let(:fixture_response) { xml_fixture_response("profile.xml") }
+
+    it "makes a get request to /profile/:profile_id with query params" do
+      expect(subject.session).to receive(:get)
+        .with("profile/#{subject.profile_id}").and_return(fixture_response)
+      subject.()
+    end
+
+    it "returns a single Profile object" do
+      subject.session.stub(:get) { fixture_response }
+      record = subject.()
+      expect(record).to be_a(WCC::Arena::Profile)
+      expect(record.name).to eq("Awesome")
+      expect(record.active_members).to eq(31699)
+    end
+
+    it "returns nil when profile not found" do
+      subject.session
+        .stub(:get) { xml_fixture_response("person_not_found.xml") }
+      expect(subject.()).to be_nil
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wcc-arena
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Travis Petticrew
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2015-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -125,6 +125,7 @@ files:
 - lib/wcc/arena/session.rb
 - lib/wcc/arena/signed_path.rb
 - lib/wcc/arena/single_person_query.rb
+- lib/wcc/arena/single_profile_query.rb
 - lib/wcc/arena/version.rb
 - spec/fixtures/group_member_list.xml
 - spec/fixtures/modify_result_failure.xml
@@ -134,6 +135,7 @@ files:
 - spec/fixtures/person_group_list.xml
 - spec/fixtures/person_list.xml
 - spec/fixtures/person_not_found.xml
+- spec/fixtures/profile.xml
 - spec/fixtures/profile_list.xml
 - spec/fixtures/profile_member_list.xml
 - spec/fixtures/profile_member_save.xml
@@ -160,6 +162,7 @@ files:
 - spec/wcc/arena/session_spec.rb
 - spec/wcc/arena/signed_path_spec.rb
 - spec/wcc/arena/single_person_query_spec.rb
+- spec/wcc/arena/single_profile_query_spec.rb
 - wcc-arena.gemspec
 homepage: https://github.com/watermarkchurch/wcc-arena
 licenses:
@@ -184,35 +187,35 @@ rubyforge_project:
 rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
-summary: "# WCC::Arena  This gem provides wrappers to the Arena church management
-  system's API. This is an early version of the library, and has had limited testing
+summary: '# WCC::Arena  This gem provides wrappers to the Arena church management
+  system''s API. This is an early version of the library, and has had limited testing
   in real world environments. Use at your own risk!  There are also bound to be a
-  few things that are specific to our configuration and version of Arena. This isn't
+  few things that are specific to our configuration and version of Arena. This isn''t
   intentional and we consider that a bug that we would like to fix. We would love
-  for this to be a fully featured way to interact with Arena's API.  ## Installation
-  \ Add this line to your application's Gemfile:  gem 'wcc-arena'  And then execute:
-  \ $ bundle  Or install it yourself as:  $ gem install wcc-arena  ## Configuration
-  \ You can configure the wcc-arena gem using the `WCC::Arena.configure` method.  Here
-  is an example configuration block:  ```ruby WCC::Arena.configure do |arena| arena.username
-  = 'username' arena.password = 'password' arena.api_key = 'api_key' arena.api_secret
-  = 'api_secret' arena.api_url = 'https://arena-domain/api.svc/' end ```  ## Usage
-  \ The library is currently a very thin layer over the Arena API. We plan to add
-  a higher level interface layer that provides a better experience for the most common
-  use cases.  The library consists of Query classes and Mapper classes. The Query
-  classes handle calling the respective services and the Mapper classes handle binding
-  the XML to Ruby objects. For full details on all available endpoints please see
-  the code. Below are a few examples of some common queries.  ```ruby person_query
-  = WCC::Arena::PersonQuery.new.where(first_name: \"Travis\") people = person_query.call
-  people.each do |person| puts person.full_name end ``` This will print the full names
-  of all person records with the first name \"Travis\". There are a ton of other attributes
-  that are available on a Person record. Check them out on the [Person](https://github.com/watermarkchurch/wcc-arena/blob/master/lib/wcc/arena/person.rb)
+  for this to be a fully featured way to interact with Arena''s API.  ## Installation  Add
+  this line to your application''s Gemfile:  gem ''wcc-arena''  And then execute:  $
+  bundle  Or install it yourself as:  $ gem install wcc-arena  ## Configuration  You
+  can configure the wcc-arena gem using the `WCC::Arena.configure` method.  Here is
+  an example configuration block:  ```ruby WCC::Arena.configure do |arena| arena.username
+  = ''username'' arena.password = ''password'' arena.api_key = ''api_key'' arena.api_secret
+  = ''api_secret'' arena.api_url = ''https://arena-domain/api.svc/'' end ```  ## Usage  The
+  library is currently a very thin layer over the Arena API. We plan to add a higher
+  level interface layer that provides a better experience for the most common use
+  cases.  The library consists of Query classes and Mapper classes. The Query classes
+  handle calling the respective services and the Mapper classes handle binding the
+  XML to Ruby objects. For full details on all available endpoints please see the
+  code. Below are a few examples of some common queries.  ```ruby person_query = WCC::Arena::PersonQuery.new.where(first_name:
+  "Travis") people = person_query.call people.each do |person| puts person.full_name
+  end ``` This will print the full names of all person records with the first name
+  "Travis". There are a ton of other attributes that are available on a Person record.
+  Check them out on the [Person](https://github.com/watermarkchurch/wcc-arena/blob/master/lib/wcc/arena/person.rb)
   model.  You can also query tags (or Profiles as they are called under the hood).
   To pull all top level Ministry tags run the following:  ```ruby # This assumes that
   your ministry tags have a type ID of 1. WCC::Arena::ProfileQuery.new(profile_type_id:
   1).call.each do |tag| puts tag.name end ```  ## Contributing  1. Fork it 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 new Pull Request"
+  commit -am ''Add some feature''`) 4. Push to the branch (`git push origin my-new-feature`)
+  5. Create new Pull Request'
 test_files:
 - spec/fixtures/group_member_list.xml
 - spec/fixtures/modify_result_failure.xml
@@ -222,6 +225,7 @@ test_files:
 - spec/fixtures/person_group_list.xml
 - spec/fixtures/person_list.xml
 - spec/fixtures/person_not_found.xml
+- spec/fixtures/profile.xml
 - spec/fixtures/profile_list.xml
 - spec/fixtures/profile_member_list.xml
 - spec/fixtures/profile_member_save.xml
@@ -248,3 +252,4 @@ test_files:
 - spec/wcc/arena/session_spec.rb
 - spec/wcc/arena/signed_path_spec.rb
 - spec/wcc/arena/single_person_query_spec.rb
+- spec/wcc/arena/single_profile_query_spec.rb