the-city-admin 0.1.4 → 0.1.5

data/.gitignore

@@ -2,3 +2,6 @@
 storage/*
 doc/*
 the-city-admin-*.gem
+bin/
+.bundle/
+.rbenv-version

data/.rvmrc

@@ -1 +1 @@
-rvm ruby-1.9.2-p290@admin-api
+rvm ruby-1.9.2-p320@admin-api

data/Gemfile

@@ -6,6 +6,6 @@ gem 'json'
 group :development, :test do
   gem 'autotest'
   gem 'rspec'
-  gem 'ruby-debug19'
+  gem 'debugger'
   gem 'factory_girl'
 end

data/Gemfile.lock

@@ -5,18 +5,22 @@ GEM
     activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    archive-tar-minitar (0.5.2)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
     columnize (0.3.6)
+    debugger (1.2.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.3)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.3)
     diff-lcs (1.1.3)
     factory_girl (4.0.0)
       activesupport (>= 3.0.0)
     ffi (1.1.5)
     i18n (0.6.1)
     json (1.7.5)
-    linecache19 (0.5.12)
-      ruby_core_source (>= 0.1.4)
     mime-types (1.19)
     multi_json (1.3.6)
     rspec (2.11.0)
@@ -27,16 +31,6 @@ GEM
     rspec-expectations (2.11.2)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.2)
-    ruby-debug-base19 (0.11.25)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby_core_source (>= 0.1.4)
-    ruby-debug19 (0.11.6)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby-debug-base19 (>= 0.11.19)
-    ruby_core_source (0.1.5)
-      archive-tar-minitar (>= 0.5.2)
     typhoeus (0.4.2)
       ffi (~> 1.0)
       mime-types (~> 1.18)
@@ -46,8 +40,8 @@ PLATFORMS
 
 DEPENDENCIES
   autotest
+  debugger
   factory_girl
   json
   rspec
-  ruby-debug19
   typhoeus

data/README.rdoc

@@ -0,0 +1,58 @@
+= The City Admin API
+
+This Ruby project is an API wrapper for TheCity Admin API (https://api.onthecity.org)
+
+
+== Install / Setup
+
+Installing the gem
+
+    gem install the-city-admin
+
+
+To add it to your Gemfile
+
+    gem 'the-city-admin', :require => 'the_city_admin'
+
+
+Add your church's City API Token and API Key to [RAILS_ROOT]/config/initializers/thecity_config.rb
+
+    THECITY_KEY = '**** YOUR CITY API KEY ****'
+    THECITY_TOKEN = '**** YOUR CITY API TOKEN ****'
+
+
+Next you will need to initialize a connection
+
+    TheCity::AdminApi.connect(THECITY_KEY, THECITY_TOKEN)
+
+
+
+== Example usage
+
+
+=== Get list of group
+
+    TheCity::AdminApi.connect(THECITY_KEY, THECITY_TOKEN)
+
+
+== Additional resources
+
+* The City Admin API: https://github.com/thecity/thecity-admin-ruby
+* The City developer community page: http://developer.onthecity.org
+
+
+== License
+
+This project is released under the MIT license (see LICENSE).
+
+This project is maintained by Wes Hays (https://github.com/weshays).
+
+
+== Contributors
+
+Chris Morris: https://github.com/chrismo
+
+
+== Want to Contribute?
+
+If you would like to get involved in this project, then please fork the project. Make changes, add features, write some tests, and then send us a pull request. 

data/examples/thecity_headers.rb

@@ -0,0 +1,49 @@
+require 'Base64'
+require 'CGI'
+require 'openssl'
+require 'net/http'
+require 'net/https'
+require 'json'
+
+
+# The City API keys
+key = '**** YOUR CITY API KEY ****'
+token = '**** YOUR CITY API TOKEN ****'
+
+
+# API endpoint to get data from
+path = '/groups'
+url = 'https://api.onthecity.org' + path
+
+
+# Build signature
+current_time = Time.now.to_i.to_s
+string_to_sign = current_time.to_s + 'GET' + url
+unencoded_hmac = OpenSSL::HMAC.digest('sha256', key, string_to_sign)
+unescaped_hmac = Base64.encode64(unencoded_hmac).chomp
+hmac_signature = CGI.escape(unescaped_hmac)
+
+
+# Build headers
+headers = {}
+headers['X-City-Sig'] = hmac_signature
+headers['X-City-User-Token'] = token
+headers['X-City-Time'] = current_time
+headers['Accept'] = 'application/vnd.thecity.admin.v1+json'
+headers['Content-Type'] = 'application/json'
+
+
+# API Request
+uri = URI.parse(url)
+http = Net::HTTP.new(uri.host, uri.port)
+http.use_ssl = true
+http.verify_mode = OpenSSL::SSL::VERIFY_NONE # read into this
+request = Net::HTTP::Get.new(uri.request_uri, headers)
+response = http.request(request)
+groups_data = JSON.parse(response.body)
+
+
+# Output group names
+groups_data['groups'].each do |group| 
+  puts group['name']
+end

data/index.rb

@@ -5,153 +5,33 @@
 # @authors Robbie Lieb <robbie@onthecity.org>, Wes Hays <wes@onthecity.org>
 # ******************************************* 
 
+
 require 'ruby-debug'
 require File.dirname(__FILE__) + '/lib/the_city_admin.rb'
 
-# key = 'cf2903151e3213e66fd8080c7d8b65b1d6ccdd31'
-# token = '5c88b32edda7653c'
-
-TCA_ENV = 'production'
+key = '132412341234123412341234'
+token = 'asdf1234asdf1234'
 
-key = '2bcee1fdccd31f1ef35a7c6708daf5a446a61ee3'
-token = 'e37ae7fb2042a17b'
 
 TheCity::AdminApi.connect(key, token)
 
-# puts "-----------------------------"
-# puts "##### USERS #######"
-# puts "-----------------------------"
-
-
-# user_list = TheCity::UserList.new
-
-# user_list.each do |u|
-#   puts u.full_name
-# end
-
-# puts "-----------------------------"
-
-# user = TheCity::User.new
-# user.title = 'Deacon'
-# user.first = 'James'
-# user.middle = 'Wesley'
-# user.last = 'Hays'
-# user.nickname = 'Wes'
-# user.gender = TheCity::User::Gender[:male]
-# user.email = 'someguy@somewhere.org'
-# user.staff = false
-# user.member_since = Time.now.strftime("%Y-%m-%d")
-# user.birthdate = '1980-09-27'
-# user.primary_phone = '775-111-2222'
-# user.primary_phone_type = TheCity::User::PhoneType[:mobile]
-# user.secondary_phone = '775-333-4444'
-# user.secondary_phone_type = TheCity::User::PhoneType[:home]
-# user.marital_status = TheCity::User::MaritalStatus[:married]
-# #user.primary_campus_id
-# #user.external_id_1
-# #user.external_id_2
-# #user.external_id_3
-
-# if user.save
-#   puts "User #{user.full_name} saved (#{user.id})"
-# else
-#   user.error_messages.each { |em| puts em }
-# end
-
-# user2 = TheCity::User.load_by_id(user.id)
-# user2.email = 'somegirl@somewhere.org'
-# user2.nickname = 'dog'
-
-# if user2.save
-#   puts "User #{user2.full_name} updated (#{user2.id})"
-# else
-#   user2.error_messages.each { |em| puts em }
-# end
-
-# if user.delete
-#   puts "User #{user.full_name} deleted (#{user.id})"
-# else
-#   puts "Something bad happened"
-#   #user.error_messages.each { |em| puts em }
-# end
-
-
-# puts "-----------------------------"
-
-# user_list = TheCity::UserList.new
-
-# user = user_list[0]
-# puts user.full_name
-# user.first = 'Wes'
-# puts user.full_name
-# user.save
-# puts user.id
-
-# user2 = TheCity::User.load_by_id(user.id)
-# puts user2.full_name
-
-# puts "User has #{user.addresses.size} addresses"
-# puts "User has #{user.family.size} family members"
-# puts "User has #{user.notes.size} notes"
-# puts "User has #{user.roles.size} roles"
-# puts "User has #{user.skills.size} skills"
-# #puts "User has #{user.processes.size} processes"
-# puts "User has #{user.invitations.size} invitations"
-# #puts "User has #{user.admin_privileges.size} admin_privileges"
-
-
-# This is currenly returning a 404 if no family members are found
-# puts user.family[0].name
-
-
-
-# puts "-----------------------------"
-
-# group_list = TheCity::GroupList.new
-# group = group_list[0]
-# puts group.name
-# group.name = 'Wes Group'
-# puts group.name
-# group.save
-# group2 = TheCity::Group.load_by_id(group.id)
-# puts group2.name
-
-
-# puts "-----------------------------"
-# puts "##### GROUPS #######"
-# puts "-----------------------------"
-
-# group_list = TheCity::GroupList.new
-
-# group = group_list[13]
-# puts "Group Name: #{group.name} (#{group.id})"
-
-# if group.roles.size == 0
-#   puts "No group roles found"
-# else
-#   puts group.roles[0].title
-# end
-
-# if group.tags.size == 0
-#   puts "No group tags found"
-# else
-#   puts group.tags[0].name
-# end
-
-# if group.invitations.size == 0
-#   puts "No group invitations found"
-# else
-#   puts group.invitations[0].id
-# end
 
+done = false
+page = 1
+count = 0
 
-puts "-----------------------------"
-puts "##### SKILLS #######"
-puts "-----------------------------"
+while !done
+  group_list = TheCity::GroupList.new({:page => page})
 
-skill_list = TheCity::SkillList.new
+  group_list.each do |group|
+    count += 1
+    puts "#{count}) #{group.name}"
+  end
 
-skill_list.each do |skill|
-  puts skill.name
+  if group_list.total_pages <= page
+    done = true
+  else
+    page += 1
+  end
 end
 

data/lib/api/pledge.rb

@@ -0,0 +1,40 @@
+module TheCity
+
+  class Pledge < ApiObject
+    tc_attr_accessor :id, 
+                     :user_id, 
+                     :fund_id, 
+                     :amount, 
+                     :pledge_date, 
+                     :created_at, 
+                     :updated_at
+
+
+    # Loads the pledge by the specified ID.
+    #
+    # @param pledge_id The ID of the pledge to load.
+    #
+    # Returns a new {Pledge} object.
+    def self.load_pledge_by_id(pledge_id)
+      pledge_reader = PledgeReader.new(Pledge_id)
+      self.new(Pledge_reader)
+    end       
+
+
+
+    # Constructor.
+    #
+    # @param reader (optional) The object that has the data.  This can be a {PledgeReader} or Hash object.
+    def initialize(reader = nil)
+      if reader.is_a?(PledgeReader)
+        initialize_from_json_object(reader.load_feed) 
+      elsif reader.is_a?(Hash)
+        initialize_from_json_object(reader)
+      end
+    end
+
+  end
+
+end
+
+

data/lib/api/pledge_list.rb

@@ -0,0 +1,74 @@
+module TheCity
+
+  class PledgeList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #   :search -  (optional) A pledge name to search on.
+    #
+    #
+    # Examples:
+    #   UserList.new
+    #
+    #   UserList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::PledgeListReader.new(options)   
+      @json_data = reader.load_feed
+
+      @total_entries = @json_data['total_entries']
+      @total_pages = @json_data['total_pages']
+      @per_page = @json_data['per_page']
+      @current_page = @json_data['current_page']      
+    end
+    
+    
+    # All the pledges in the list.
+    #
+    # @return array of pledge names.
+    def all_names
+      @json_data['pledges'].collect { |pledge| pledge['id'] }
+    end
+    alias :names :all_names
+    
+    
+    # Get the specified pledge.
+    #
+    # @param index The index of the pledge to get.
+    #
+    # @return [pledge]
+    def [](index)
+      pledge.new( @json_data['pledges'][index] ) if @json_data['pledges'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['pledges'].each{ |pledge| yield( Pledge.new(pledge) )}
+    end    
+
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['pledges'].empty?
+    end    
+  
+  end
+  
+end