doattend 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55e9a582e16a82877230f4b1874de7489c78aaf2
-  data.tar.gz: b86cec3f63f10bef4a6c11fbe4cbbfbd395a1570
+  metadata.gz: b430ff4f45048ed5826060285b2558271d07d9f6
+  data.tar.gz: 6162cf7b437b8037da812bff7b464efbb5fc96f8
 SHA512:
-  metadata.gz: f2974578151d87e72821dd19ac4033ed886347eacad7ddfdee69985bd6f6dc1cbedfa8a704e350b2abf1634bdf9e959c88e8074a2e4665ab8f017a63817dd6f7
-  data.tar.gz: 563148a29c6a90d79618696a53e177c3de57bac008c0d2de90333eb4055e79c27f4d14d1ffa29d775233a5a855cf2a0371b91c7a260308b4fe84acfc904bd6e3
+  metadata.gz: 9c6c0b675729091b1ca9453f940776eafb6fb95238050d6c33c6c1d095ec3a0cde6590028be48cf463927bd0107315b0f294622995db8c837fd08a107ddaa77f
+  data.tar.gz: fe830af5b2b57cce2eb87a8be8262894afd27507c83f517547f53e0b116011bb056313c3233e1cdf550d9fc0bace62052cf0dda87d523c85246dac9a606297fe

data/README.md

@@ -1,6 +1,9 @@
 # DoAttend
 
-Rails generator and functions to communicate the DoAttend API.
+[![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)
+
+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.
 
 ## Installation
 
@@ -18,7 +21,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Doattend provides a rails generator that gets you started quikly. 
+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:
+		$ require "doattend"
+
+## Getting Started
+		Rails Way:
+		@doattend = Doattend::Base.new # This loads the key and event that was generated from config/doattend.yml
+
+		Non-Rails Way:
+		@doattend = Doattend::Base.new('YOUR_DOATTEND_EVENT_ID', 'YOUR_DOATTEND_API_KEY')
+
+
+## Methods
+#### Fetch all data from DoAttend
+		@doattend.fetch
+
+#### Get total tickets
+		@doattend.aggregate
+
+#### Get ticket names/types used in an event
+		@doattend.ticket.names
+
+#### Get total number of registrations for a ticket name/type
+		@doattend.ticket.aggregate('ticket_type')
+
+		Eg.:
+		@doattend.ticket.aggregate(@doattend.ticket.names.first)
 
 ## Contributing
 

data/lib/doattend.rb

@@ -1,11 +1,3 @@
 require "doattend/version"
 require "doattend/base.rb"
 
-module Doattend
-
-  # Fetch data from DoAttend API.
-  def self.fetch
-  	Doattend::Base.fetch
-  end
-
-end

data/lib/doattend/base.rb

@@ -1,19 +1,46 @@
 require "rest-client"
+require "json"
+
+require_relative "ticket.rb"
 
 module Doattend
 	
 	class Base
 		
-		def self.fetch
-	  	conf = YAML.load_file("#{Rails.root}/config/doattend.yml")
-  		url = "http://doattend.com/api/events/#{conf['doattend']['event']}/participants_list.json?api_key=#{conf['doattend']['key']}"
+		attr_accessor :event, :key, :result
+
+		def initialize(e=nil, k=nil)
+			if defined? Rails
+	  		conf = YAML.load_file("#{Rails.root}/config/doattend.yml")
+	  		self.event = conf['doattend']['event']
+	  		self.key = conf['doattend']['key']
+	  	else
+	  		self.event = e
+	  		self.key = k
+	  	end
+
+		end
+		
+		# Request DoAttend and fetch results.
+		def fetch
+  		url = "http://doattend.com/api/events/#{self.event}/participants_list.json?api_key=#{self.key}"
   		begin
-  			RestClient.get(url)
+  			self.result = JSON.parse(RestClient.get(url))
   		rescue Exception => e
   			e
 			end
 		end
 
+		# Get Total Participants.
+		def aggregate
+			self.result['participants'].size
+		end
+
+		# Use methods of Ticket class.
+		def ticket
+			Doattend::Ticket.new(self.result['participants'])
+		end
+
 	end
 
 end

data/lib/doattend/ticket.rb

@@ -0,0 +1,23 @@
+module Doattend
+
+	class Ticket
+		
+		attr_accessor :result
+
+		def initialize(result)
+			self.result = result
+		end
+		
+		# Returns different ticket names that is available for the event.
+		def names
+			self.result.map{ |t| t['Ticket_Name'] }.uniq
+		end
+		
+		# Returns number of registrations for a ticket type
+		def aggregate(name)
+			self.result.count{ |t| t['Ticket_Name'] == name }
+		end
+
+	end
+
+end

data/lib/doattend/version.rb

@@ -1,3 +1,3 @@
 module Doattend
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doattend
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Swaroop SM
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yaml
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -90,6 +90,7 @@ files:
 - README.md
 - Gemfile
 - Rakefile
+- lib/doattend/ticket.rb
 - lib/doattend/version.rb
 - lib/doattend/base.rb
 - lib/generators/doattend/install/USAGE