doattend 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4002d28ae6dbafae05ef592835e2c429b300c74c
-  data.tar.gz: f1ee4c95a35f60544f5f17ffce1062573042ae2b
+  metadata.gz: 4c8f939f5c50767f5eb9bafad844ad915438a4fc
+  data.tar.gz: 921f1443be878ba218ace7f2971556d7988196db
 SHA512:
-  metadata.gz: 7e9fd3f9fc03f9d2f498b3c3b83c2e40fa5415dc486e9c907c2046f3d1c61d35c08e334a731d3153f53a6828cc7a3af7795acef92f151b71cf76c726c6be6c43
-  data.tar.gz: d843d0e2bc51af171d8a1200cc3b51b023c0cfadf195503c1a9e62d3ab43c6f97407ce80f0e578bbda15b2bb42b09f56c1af590bb15d005a8b77b1f030fc62a2
+  metadata.gz: f5a45681208778c0e4b2c4b448fb119ee6a1e4edb35eca86935f4131c66f9af104437d5a0032647c31f4a46e71f19aa8b12ec36268d94748dc2c69ccab42b15d
+  data.tar.gz: cf5f684471e6b01993d14cf598a9cb5ee5215a9b266637900ee8aef943ee25604b056409a6996de71f61d4b83330e2647e33dd21ce111b2e4feba96277e8b842

data/README.md

@@ -2,6 +2,9 @@
 
 [![Gem Version](https://badge.fury.io/rb/doattend.png)](http://badge.fury.io/rb/doattend)
 [![Code Climate](https://codeclimate.com/github/swaroopsm/doattend.png)](https://codeclimate.com/github/swaroopsm/doattend)
+[![Dependency Status](https://gemnasium.com/swaroopsm/doattend.png)](https://gemnasium.com/swaroopsm/doattend)
+[![Build Status](https://travis-ci.org/swaroopsm/doattend.png?branch=master)](https://travis-ci.org/swaroopsm/doattend)
+[![Stories in Ready](https://badge.waffle.io/swaroopsm/doattend.png?label=ready)](https://waffle.io/swaroopsm/doattend)  
 
 Rails generator and functions to communicate the DoAttend API. You need to have a DoAttend API key to communicate the DoAttend API. If you do not have one yet, you can contact DoAttend to get an API key.
 
@@ -21,12 +24,12 @@ Or install it yourself as:
 
 ## Usage
 
-Doattend provides a rails generator that gets you started quikly. 
+Doattend provides a rails generator that gets you started quickly. 
 Run the following generator to generate config/doattend.yml
 		
 		$ rails g doattend:install -e YOUR_DOATTEND_EVENT_ID -k YOUR_DOATTEND_API_KEY
 
-If you are not using Rails you can use require to include it:
+#####If you are not using Rails you can use require to include it:
 		$ require "doattend"
 
 ## Getting Started
@@ -35,14 +38,16 @@ If you are not using Rails you can use require to include it:
 
 		Non-Rails Way:
 		doattend = Doattend::Base.new('YOUR_DOATTEND_EVENT_ID', 'YOUR_DOATTEND_API_KEY')
+		
+		Fetch all data:
+		doattend.fetch
+		
 
 
 ## Methods
-### Tickets
-#### Fetch all data from DoAttend
-		doattend.fetch
 
-#### Get total tickets
+### 1. Ticket
+#### Get total number of tickets
 		doattend.aggregate
 
 #### Get ticket names/types used in an event
@@ -54,12 +59,28 @@ If you are not using Rails you can use require to include it:
 		Eg.:
 		doattend.ticket.aggregate(doattend.ticket.names.first)
 
-### Participants
-#### Pluck a field from all all participants
+### 2. Participants
+
+#### Find a participant by ticket number
+		 doattend.participant.find('TICKET_NUMBER')
+
+#### Ascertain whether a key == value
+		 doattend.participant.ascertain('KEY', 'VALUE')
+
+		 Eg.:
+		 doattend.participant.ascertain('Gender', 'Male')
+
+#### Return participant objects registered on a specfied date
+		 doattend.participant.registered.on(DATE_OBJECT)
+
+		 Eg.:
+		 doattend.participant.registered.on(Date.new(2013,5,8))
+
+#### Pluck a field from all participants
 		doattend.participant.pluck('FIELD_NAME')
 
 		Eg.:
-		doattend.participant.plcuk('Gender')
+		doattend.participant.pluck('Gender')
 
 ## Contributing
 

data/lib/doattend/base.rb

@@ -8,7 +8,7 @@ module Doattend
 	
 	class Base
 		
-		attr_accessor :event, :key, :result
+		attr_accessor :event, :key, :result, :url
 
 		def initialize(e=nil, k=nil)
 			if defined? Rails
@@ -19,16 +19,15 @@ module Doattend
 	  		self.event = e
 	  		self.key = k
 	  	end
-
+			self.url = "http://doattend.com/api/events/#{self.event}/participants_list.json?api_key=#{self.key}"
 		end
 		
 		# Request DoAttend and fetch results.
 		def fetch
-  		url = "http://doattend.com/api/events/#{self.event}/participants_list.json?api_key=#{self.key}"
   		begin
   			self.result = JSON.parse(RestClient.get(url))
   		rescue Exception => e
-  			e
+  			raise e
 			end
 		end
 

data/lib/doattend/participant.rb

@@ -10,7 +10,7 @@ module Doattend
 			self.general_info = ['Ticket_Number', 'Email', 'Date', 'Name']
 		end
 
-		# Pluck a particular field from participants
+		# Pluck a particular field from participants.
 		def pluck(field)
 			if self.general_info.include? field
 				self.result.map{ |p| p[field] }
@@ -18,6 +18,30 @@ module Doattend
 				self.result.map{ |p| p['participant_information'].select{ |a| a['desc'] == field } }.flatten.map{ |x| x['info'] }
 			end
 		end
+		
+		# Default Participant Finder. Returns a participant having the specified ticket number.
+		def find(ticket)
+			self.result.select{ |p| p['Ticket_Number'] == ticket }.first
+		end
+
+		# Count occurences of key/value.
+		def ascertain(k, v)
+			if self.general_info.include? k
+				self.result.count{ |p| p[k] == v.downcase }				
+			else
+				self.result.map{ |p| p['participant_information'].select{ |i| i['desc'].strip.downcase == k.split('_').join(' ').downcase and i['info'].strip.downcase == v.downcase  } }.flatten.size
+			end
+		end
+
+		# Return participants who have registered on a particular date.
+		def registered
+			self
+		end
+
+		def on(date)
+			self.result.select{ |p| Date.iso8601(p['Date']).strftime == date.strftime }
+		end
+
 
 	end
 

data/lib/doattend/version.rb

@@ -1,3 +1,3 @@
 module Doattend
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/base_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+require "doattend/base"
+
+describe Doattend::Base do
+	
+	before(:each) do
+		@doattend = Doattend::Base.new('EVENT_ID', 'API_KEY')
+		sample_response = File.new(File.expand_path('../example.json', __FILE__))
+		stub_request(:get, @doattend.url).to_return(:body => sample_response)
+		@doattend.fetch		
+	end
+	
+	it "should be an instance of Ticket" do
+		@doattend.ticket.should be_instance_of Doattend::Ticket
+	end
+
+	it "should be an instance of Participant" do
+		@doattend.participant.should be_instance_of Doattend::Participant
+	end
+
+	it "should return total number of registrations" do
+		@doattend.aggregate.should eq 11
+	end
+
+end

data/spec/example.json

@@ -0,0 +1,323 @@
+{
+    "participants": [
+        {
+            "Date": "2013-05-08T05:11:08Z", 
+            "Email": "abc@example.org", 
+            "Name": null, 
+            "Ticket_Name": "Test Registration", 
+            "Ticket_Number": "326817", 
+            "participant_information": [
+                {
+                    "desc": "First Name", 
+                    "info": "Manic"
+                }, 
+                {
+                    "desc": "Gender", 
+                    "info": "Other"
+                }, 
+                {
+                    "desc": "Last Name", 
+                    "info": "Raman"
+                }, 
+                {
+                    "desc": "Date of Birth", 
+                    "info": "May-15-1996"
+                }, 
+                {
+                    "desc": "Nationality", 
+                    "info": "Albania"
+                }
+            ]
+        }, 
+        {
+            "Date": "2013-05-02T18:33:36Z", 
+            "Email": "wolverine@example.org", 
+            "Name": null, 
+            "Ticket_Name": "Test Registration", 
+            "Ticket_Number": "325434", 
+            "participant_information": [
+                {
+                    "desc": "First Name", 
+                    "info": "Logan"
+                }, 
+                {
+                    "desc": "Gender", 
+                    "info": "Male"
+                }, 
+                {
+                    "desc": "Last Name", 
+                    "info": "Torsekar"
+                }, 
+                {
+                    "desc": "Date of Birth", 
+                    "info": "May-06-1975"
+                }, 
+                {
+                    "desc": "Nationality", 
+                    "info": "empty"
+                }
+            ]
+        }, 
+        {
+            "Date": "2013-04-30T07:18:30Z", 
+            "Email": "batman@example.org", 
+            "Name": null, 
+            "Ticket_Name": "Test Registration", 
+            "Ticket_Number": "324549", 
+            "participant_information": [
+                {
+                    "desc": "First Name", 
+                    "info": "Bruce"
+                }, 
+                {
+                    "desc": "Gender", 
+                    "info": "Male"
+                }, 
+                {
+                    "desc": "Last Name", 
+                    "info": "Wayne"
+                }, 
+                {
+                    "desc": "Date of Birth", 
+                    "info": "Apr-28-1982"
+                }, 
+                {
+                    "desc": "Nationality", 
+                    "info": "empty"
+                }
+            ]
+        }, 
+        {
+            "Date": "2013-04-30T05:15:48Z", 
+            "Email": "thor@example.org", 
+            "Name": null, 
+            "Ticket_Name": "Test Registration", 
+            "Ticket_Number": "324521", 
+            "participant_information": [
+                {
+                    "desc": "thor", 
+                    "info": "Test"
+                }, 
+                {
+                    "desc": "Gender", 
+                    "info": "Male"
+                }, 
+                {
+                    "desc": "Last Name", 
+                    "info": "Thunder"
+                }, 
+                {
+                    "desc": "Date of Birth", 
+                    "info": "Sep-04-1755"
+                }, 
+                {
+                    "desc": "Nationality", 
+                    "info": "Asgard"
+                }
+            ]
+        }, 
+        {
+            "Date": "2013-04-26T10:16:10Z", 
+            "Email": "van@example.org", 
+            "Name": null, 
+            "Ticket_Name": "Test Registration", 
+            "Ticket_Number": "323367", 
+            "participant_information": [
+                {
+                    "desc": "First Name", 
+                    "info": "Van"
+                }, 
+                {
+                    "desc": "Gender", 
+                    "info": "Male"
+                }, 
+                {
+                    "desc": "Last Name", 
+                    "info": "Helsing"
+                }, 
+                {
+                    "desc": "Date of Birth", 
+                    "info": "Jun-26-1986"
+                }, 
+                {
+                    "desc": "Nationality", 
+                    "info": "empty"
+                }
+            ]
+        }, 
+        {
+            "Date": "2013-04-22T17:23:56Z", 
+            "Email": "jonh.doe@example.org", 
+            "Name": null, 
+            "Ticket_Name": "Test Registration", 
+            "Ticket_Number": "322474", 
+            "participant_information": [
+                {
+                    "desc": "First Name", 
+                    "info": "John"
+                }, 
+                {
+                    "desc": "Gender", 
+                    "info": "Male"
+                }, 
+                {
+                    "desc": "Last Name", 
+                    "info": "Doe"
+                }, 
+                {
+                    "desc": "Date of Birth", 
+                    "info": "Apr-28-1913"
+                }, 
+                {
+                    "desc": "Nationality", 
+                    "info": "empty"
+                }
+            ]
+        }, 
+        {
+            "Date": "2013-04-20T12:24:13Z", 
+            "Email": "jack@example.org", 
+            "Name": null, 
+            "Ticket_Name": "Test Registration", 
+            "Ticket_Number": "322085", 
+            "participant_information": [
+                {
+                    "desc": "First Name", 
+                    "info": "Jack"
+                }, 
+                {
+                    "desc": "Gender", 
+                    "info": "Male"
+                }, 
+                {
+                    "desc": "Last Name", 
+                    "info": "Fernandez"
+                }, 
+                {
+                    "desc": "Date of Birth", 
+                    "info": "Oct-12-1981"
+                }, 
+                {
+                    "desc": "Nationality", 
+                    "info": "empty"
+                }
+            ]
+        }, 
+        {
+            "Date": "2013-04-17T04:46:26Z", 
+            "Email": "carter@example.org", 
+            "Name": null, 
+            "Ticket_Name": "Test Registration", 
+            "Ticket_Number": "320774", 
+            "participant_information": [
+                {
+                    "desc": "First Name", 
+                    "info": "Paul"
+                }, 
+                {
+                    "desc": "Gender", 
+                    "info": "Carter"
+                }, 
+                {
+                    "desc": "Last Name", 
+                    "info": "J"
+                }, 
+                {
+                    "desc": "Date of Birth", 
+                    "info": "Apr-17-2013"
+                }, 
+                {
+                    "desc": "Nationality", 
+                    "info": "empty"
+                }
+            ]
+        }, 
+        {
+            "Date": "2013-04-12T04:27:33Z", 
+            "Email": "fizz@example.org", 
+            "Name": null, 
+            "Ticket_Name": "Test Registration for Copy of test", 
+            "Ticket_Number": "319951", 
+            "participant_information": [
+                {
+                    "desc": "First Name", 
+                    "info": "Fizz"
+                }, 
+                {
+                    "desc": "Gender", 
+                    "info": "Male"
+                }, 
+                {
+                    "desc": "Last Name", 
+                    "info": "Buzz"
+                }, 
+                {
+                    "desc": "Date of Birth", 
+                    "info": "Oct-18-1984"
+                }, 
+                {
+                    "desc": "Nationality", 
+                    "info": "empty"
+                }
+            ]
+        }, 
+        {
+            "Date": "2013-04-11T05:37:21Z", 
+            "Email": "fred@example.com", 
+            "Name": null, 
+            "Ticket_Name": "Test Registration for Copy of test", 
+            "Ticket_Number": "319165", 
+            "participant_information": [
+                {
+                    "desc": "First Name", 
+                    "info": "Derek"
+                }, 
+                {
+                    "desc": "Gender", 
+                    "info": "empty"
+                }, 
+                {
+                    "desc": "Last Name", 
+                    "info": "Fred"
+                }, 
+                {
+                    "desc": "Date of Birth", 
+                    "info": "Apr-28-1982"
+                }, 
+                {
+                    "desc": "Nationality", 
+                    "info": "Indian"
+                }
+            ]
+        }, 
+        {
+            "Date": "2013-04-09T06:08:59Z", 
+            "Email": "mark@example.org", 
+            "Name": null, 
+            "Ticket_Name": "Test Registration for Copy of test", 
+            "Ticket_Number": "318800", 
+            "participant_information": [
+                {
+                    "desc": "First Name", 
+                    "info": "Mark"
+                }, 
+                {
+                    "desc": "Gender", 
+                    "info": "male"
+                }, 
+                {
+                    "desc": "Last Name", 
+                    "info": "Brandin"
+                }, 
+                {
+                    "desc": "Date of Birth", 
+                    "info": "Apr-28-1982"
+                }, 
+                {
+                    "desc": "Nationality", 
+                    "info": "empty"
+                }
+            ]
+        }
+    ]
+}

data/spec/participant_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+require "doattend/base"
+
+describe Doattend::Participant do
+	
+	before(:each) do
+		@doattend = Doattend::Base.new('EVENT_ID', 'API_KEY')
+		sample_response = File.new(File.expand_path('../example.json', __FILE__))
+		stub_request(:get, @doattend.url).to_return(:body => sample_response)
+		@doattend.fetch		
+	end
+
+	it "should pluck all ticket numbers" do
+		@doattend.participant.pluck("Ticket_Number").should eq ["326817", "325434", "324549", "324521", "323367", "322474", "322085", "320774", "319951", "319165", "318800"]
+	end
+
+	it "should return a valid particpant hash of the specified ticket" do
+		@doattend.participant.find('326817').should be_kind_of Hash
+	end
+
+	it "should return nil for an invalid ticket number" do
+		@doattend.participant.find('316117').should be_nil
+	end
+	
+	it "should return the number of occurrences who are male participants" do
+		@doattend.participant.ascertain('Gender', 'Male').should eq 8
+	end
+
+	it "should return the number of " do
+		@doattend.participant.ascertain('Nationality', 'Asgard').should eq 1
+	end
+
+	it "should return an array of participant objects for a given date" do
+		@doattend.participant.registered.on(Date.new(2013,5,8)).should be_kind_of Array
+	end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require "webmock/rspec"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/ticket_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+require "doattend/base"
+
+describe Doattend::Ticket do
+	
+	before(:each) do
+		@doattend = Doattend::Base.new('EVENT_ID', 'API_KEY')
+		sample_response = File.new(File.expand_path('../example.json', __FILE__))
+		stub_request(:get, @doattend.url).to_return(:body => sample_response)
+		@doattend.fetch		
+	end
+
+	it "ticket names should be an array" do
+		@doattend.ticket.names.should be_kind_of Array
+	end
+		
+	it "should return the first ticket name" do
+		@doattend.ticket.names.first.should eq "Test Registration" 
+	end
+
+	it "should return number of registrations for a ticket type" do
+		@doattend.ticket.aggregate(@doattend.ticket.names.first).should eq 8 
+	end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doattend
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Swaroop SM
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2013-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,18 +38,46 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.13
 - !ruby/object:Gem::Dependency
@@ -80,7 +108,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Communicating with DoAttend API
+description: Methods to parse data from DoAttend API
 email:
 - swaroop.striker@gmail.com
 executables: []
@@ -90,6 +118,11 @@ files:
 - README.md
 - Gemfile
 - Rakefile
+- spec/example.json
+- spec/ticket_spec.rb
+- spec/participant_spec.rb
+- spec/spec_helper.rb
+- spec/base_spec.rb
 - lib/doattend/ticket.rb
 - lib/doattend/version.rb
 - lib/doattend/participant.rb
@@ -121,6 +154,11 @@ rubyforge_project:
 rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
-summary: This provides a rails generator and functions to communicate with the DoAttend
-  API.
-test_files: []
+summary: This provides a rails generator and functions to communicate and parse data
+  from DoAttend API.
+test_files:
+- spec/example.json
+- spec/ticket_spec.rb
+- spec/participant_spec.rb
+- spec/spec_helper.rb
+- spec/base_spec.rb