wcc-arena 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 847a7b9b46ead985eb00221fb3ce685215671746
-  data.tar.gz: 7ce4cea280b3de3c7761e64619d5d3af2083caab
+  metadata.gz: 78c775b268d1495b0152e28aae31f6f6ad495b33
+  data.tar.gz: 373f450d5c5e8a9ae3ec92df844f19175fc9010e
 SHA512:
-  metadata.gz: 23dda6c3fc79b84e9934f985c73ebc1d64dff57244b5780c24e05c8bbebb0d0a995dbf955398f5f941afc9dc7f9d1898b408d80b18cd0e3ee3cbd3861fe81d72
-  data.tar.gz: 5b504562dd6e74c74fec426714500952a07a6410facf94f41765df9b7753487502aebe295efa6622daf75f1cb7154b2ee46e240079bf1934c00f8988e8d35839
+  metadata.gz: 3dad2d3af57efabe8fede201ac7f1acc1e29356c30bc6b15307758943168c10f2b78d45b208ac0a1bd6212518f92fd788d98c5d29ea062e280282657138d988e
+  data.tar.gz: 193c355b203bfd6cde237e4c22888d7eb78a800f31a5bc4361561270c353b4bfe3ea9531fa8799f1454e63a744310f1183bcdb266ebf5e1d3e7d1a646ae1845b

data/README.md

@@ -38,7 +38,7 @@ WCC::Arena.configure do |arena|
   arena.api_secret = 'api_secret'
   arena.api_url = 'https://arena-domain/api.svc/'
 end
-```end
+```
 
 ## Usage
 
@@ -53,14 +53,27 @@ available endpoints please see the code. Below are a few examples of
 some common queries.
 
 ```ruby
-query = WCC::Arena::PersonQuery.new.where(first_name: "Travis")
-people = query.call
+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".
+"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
 

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/wcc/arena/group_query.rb

@@ -1,5 +1,4 @@
 module WCC::Arena
-
   class GroupQuery
     attr_reader :session
     attr_reader :person_id
@@ -12,15 +11,14 @@ module WCC::Arena
     end
 
     def call
-      response_groups_xml.collect do |person_xml|
-        Group.new(person_xml)
-      end
+      groups = response_groups_xml.map { |person_xml| Group.new(person_xml) }
+      groups.uniq { |g| g.id }
     end
 
     private
 
     def response_groups_xml
-      query_response.xml.root.xpath("Groups/Group")
+      query_response.xml.root.xpath("Groups/Group[not(LeaderID='-1')]")
     end
 
     def query_response
@@ -29,8 +27,5 @@ module WCC::Arena
         categoryid: category_id
       )
     end
-
-
   end
-
 end

data/lib/wcc/arena/person.rb

@@ -1,4 +1,5 @@
 require 'wcc/arena/person_query'
+require 'wcc/arena/single_person_query'
 
 require 'wcc/arena/address'
 require 'wcc/arena/email'

data/lib/wcc/arena/profile_member.rb

@@ -9,7 +9,7 @@ module WCC::Arena
     attribute :person_id, xpath: "PersonInformation/PersonID", type: :integer
 
     def person
-      @person ||= PersonQuery.new.where(person_id: person_id).()[0]
+      @person ||= SinglePersonQuery.new(person_id: person_id).()
     end
 
   end

data/lib/wcc/arena/single_person_query.rb

@@ -0,0 +1,25 @@
+module WCC::Arena
+  class SinglePersonQuery
+    attr_reader :session
+    attr_reader :person_id
+
+    def initialize(args={})
+      @session = args.fetch(:session) { WCC::Arena.config.session }
+      @person_id = args.fetch(:person_id)
+    end
+
+    def call
+      Person.new(response_person_xml)
+    end
+
+    private
+
+    def response_person_xml
+      query_response.xml.root.xpath("/Person")[0]
+    end
+
+    def query_response
+      @response ||= session.get("person/#{person_id}")
+    end
+  end
+end

data/lib/wcc/arena/version.rb

@@ -1,5 +1,5 @@
 module WCC
   module Arena
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/fixtures/person_group_list.xml

@@ -48,5 +48,88 @@
       <TopicID>500050</TopicID>
       <TopicValue>Unknown</TopicValue>
     </Group>
+    <Group>
+      <Active>true</Active>
+      <AreaID>9</AreaID>
+      <AreaName>North Dallas Area</AreaName>
+      <AverageAge>27</AverageAge>
+      <Description/>
+      <GroupClusterID>1378</GroupClusterID>
+      <GroupClusterTitle>Small Group Awesome</GroupClusterTitle>
+      <GroupID>1407</GroupID>
+      <GroupTypeID>-1</GroupTypeID>
+      <GroupTypeValue>Unknown</GroupTypeValue>
+      <GroupUrl/>
+      <Guid>56d153b5-9c30-41d8-9f0c-c566d42ecde8</Guid>
+      <ImageBlobLink/>
+      <LeaderID>168827</LeaderID>
+      <LeaderLink>person/168827</LeaderLink>
+      <MaxMembers>20</MaxMembers>
+      <MeetingDayID>9</MeetingDayID>
+      <MeetingDayValue>Sunday</MeetingDayValue>
+      <MeetingEndTime>1900-01-01T00:00:00</MeetingEndTime>
+      <MeetingStartTime>1900-01-01T00:00:00</MeetingStartTime>
+      <MemberLink>group/1407/member/list</MemberLink>
+      <Name>Small Group Awesome</Name>
+      <Notes/>
+      <PictureUrl/>
+      <PrimaryAgeID>337</PrimaryAgeID>
+      <PrimaryAgeValue>Any</PrimaryAgeValue>
+      <PrimaryMaritalStatusID>338</PrimaryMaritalStatusID>
+      <PrimaryMaritalStatusValue>Any</PrimaryMaritalStatusValue>
+      <Schedule/>
+      <TargetLocation>
+        <AddressID>115364</AddressID>
+        <City>Dallas</City>
+        <Country>US</Country>
+        <Latitude>32.019239</Latitude>
+        <Longitude>-97.296295</Longitude>
+        <PostalCode>75000-1234</PostalCode>
+        <Primary>true</Primary>
+        <State>TX</State>
+        <StreetLine1>123 Main St</StreetLine1>
+        <StreetLine2/>
+      </TargetLocation>
+      <TargetLocationID>168827</TargetLocationID>
+      <Title>Small Group Awesome</Title>
+      <TopicID>500050</TopicID>
+      <TopicValue>Unknown</TopicValue>
+    </Group>
+    <Group>
+      <Active>true</Active>
+      <AreaID>10</AreaID>
+      <AreaName>North Dallas Area</AreaName>
+      <AverageAge>27</AverageAge>
+      <Description/>
+      <GroupClusterID>1379</GroupClusterID>
+      <GroupClusterTitle>Small Group Awesome</GroupClusterTitle>
+      <GroupID>1408</GroupID>
+      <GroupTypeID>-1</GroupTypeID>
+      <GroupTypeValue>Unknown</GroupTypeValue>
+      <GroupUrl/>
+      <Guid>56d153b5-9c30-41d8-9f0c-c566d42ecef9</Guid>
+      <ImageBlobLink/>
+      <LeaderID>-1</LeaderID>
+      <LeaderLink>person/168828</LeaderLink>
+      <MaxMembers>20</MaxMembers>
+      <MeetingDayID>9</MeetingDayID>
+      <MeetingDayValue>Sunday</MeetingDayValue>
+      <MeetingEndTime>1900-01-01T00:00:00</MeetingEndTime>
+      <MeetingStartTime>1900-01-01T00:00:00</MeetingStartTime>
+      <MemberLink>group/1408/member/list</MemberLink>
+      <Name>Small Group Awesome</Name>
+      <Notes/>
+      <PictureUrl/>
+      <PrimaryAgeID>337</PrimaryAgeID>
+      <PrimaryAgeValue>Any</PrimaryAgeValue>
+      <PrimaryMaritalStatusID>338</PrimaryMaritalStatusID>
+      <PrimaryMaritalStatusValue>Any</PrimaryMaritalStatusValue>
+      <Schedule/>
+      <TargetLocation/>
+      <TargetLocationID>168828</TargetLocationID>
+      <Title>Small Group Awesome</Title>
+      <TopicID>500051</TopicID>
+      <TopicValue>Unknown</TopicValue>
+    </Group>
   </Groups>
 </GroupListResult>

data/spec/wcc/arena/group_query_spec.rb

@@ -38,19 +38,28 @@ describe WCC::Arena::GroupQuery do
 
   describe "#call" do
     let(:fixture_response) { xml_fixture_response("person_group_list.xml") }
+    let(:list) { subject.() }
 
     it "does a get request to the person group list service" do
       expect(subject.session).to receive(:get).with("person/45/group/list", categoryid: 1).and_return(fixture_response)
-      subject.()
+      list
     end
 
     it "returns an array of Group objects" do
       subject.session.stub(:get) { fixture_response }
-      list = subject.()
       list.each do |item|
         expect(item).to be_a(WCC::Arena::Group)
       end
     end
-  end
 
+    it "excludes deleted groups" do
+      subject.session.stub(:get) { fixture_response }
+      expect(list.map(&:leader_id)).to_not include(-1)
+    end
+
+    it "returns groups with unique IDs" do
+      subject.session.stub(:get) { fixture_response }
+      expect(list.map(&:id).uniq.size).to eq(list.size)
+    end
+  end
 end

data/spec/wcc/arena/profile_member_spec.rb

@@ -22,18 +22,17 @@ describe WCC::Arena::ProfileMember do
   end
 
   describe "#person method" do
+    let(:person_id) { 123 }
     before(:each) do
-      subject.stub(:person_id) { 123 }
+      subject.stub(:person_id) { person_id }
     end
 
-    it "fetchs builds and executes a PersonQuery on the person_id attribute" do
-      person_query = double(:person_query)
-      expect(WCC::Arena::PersonQuery).to receive(:new).and_return(person_query).once
-      expect(person_query).to receive(:where).with(person_id: 123).and_return(-> { [:record] })
+    it "fetchs builds and executes a SinglePersonQuery on the person_id attribute" do
+      expect(WCC::Arena::SinglePersonQuery).to receive(:new).once
+        .with(person_id: person_id).and_return(-> { :record })
       expect(subject.person).to eq(:record)
       expect(subject.person).to eq(:record)
     end
-
   end
 
 end

data/spec/wcc/arena/session_spec.rb

@@ -88,7 +88,7 @@ describe WCC::Arena::Session do
 
     describe "#expires" do
       it "returns the DateExpires from the credentialing API call" do
-        expect(subject.expires).to be_within(1).of(Time.new(2213, 12, 20, 14, 46, 43))
+        expect(subject.expires).to be_within(1).of(Time.new(2213, 12, 20, 14, 46, 43, "-06:00"))
       end
     end
   end

data/spec/wcc/arena/single_person_query_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe WCC::Arena::SinglePersonQuery do
+  include FixturesHelpers
+
+  subject { described_class.new(args) }
+  let(:args) {
+    {
+      session: double("session"),
+      person_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 person_id argument" do
+      args.delete(:person_id)
+      expect { described_class.new(args) }.to raise_error(KeyError)
+    end
+  end
+
+  describe "#call" do
+    let(:fixture_response) { xml_fixture_response("person.xml") }
+
+    it "makes a get request to /person/list with query params" do
+      expect(subject.session).to receive(:get)
+        .with("person/#{subject.person_id}").and_return(fixture_response)
+      subject.()
+    end
+
+    it "returns a single Person object" do
+      subject.session.stub(:get) { fixture_response }
+      record = subject.()
+      expect(record).to be_a(WCC::Arena::Person)
+      expect(record.first_name).to eq("Donald")
+      expect(record.last_name).to eq("Duck")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wcc-arena
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Travis Petticrew
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -85,7 +85,9 @@ description: Watermark's library for interfacing with Arena ChMS's web API
 email:
 - travis@petticrew.net
 - dev@watermark.org
-executables: []
+executables:
+- autospec
+- rspec
 extensions: []
 extra_rdoc_files: []
 files:
@@ -95,6 +97,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/autospec
+- bin/rspec
 - lib/wcc/arena.rb
 - lib/wcc/arena/address.rb
 - lib/wcc/arena/config.rb
@@ -120,6 +124,7 @@ files:
 - lib/wcc/arena/response.rb
 - lib/wcc/arena/session.rb
 - lib/wcc/arena/signed_path.rb
+- lib/wcc/arena/single_person_query.rb
 - lib/wcc/arena/version.rb
 - spec/fixtures/group_member_list.xml
 - spec/fixtures/modify_result_failure.xml
@@ -153,6 +158,7 @@ files:
 - spec/wcc/arena/response_spec.rb
 - spec/wcc/arena/session_spec.rb
 - spec/wcc/arena/signed_path_spec.rb
+- spec/wcc/arena/single_person_query_spec.rb
 - wcc-arena.gemspec
 homepage: https://github.com/watermarkchurch/wcc-arena
 licenses:
@@ -174,33 +180,38 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+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 ```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 query =
-  WCC::Arena::PersonQuery.new.where(first_name: "Travis") people = 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".  ## Contributing  1. Fork it 2. Create
+  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
@@ -234,3 +245,4 @@ test_files:
 - spec/wcc/arena/response_spec.rb
 - spec/wcc/arena/session_spec.rb
 - spec/wcc/arena/signed_path_spec.rb
+- spec/wcc/arena/single_person_query_spec.rb