the-city-admin 0.4.0 → 0.5.0

data/examples/city_keys.rb

@@ -1,6 +1,6 @@
 module CityKeys
 
-  KEY = 'cf2903151e3213e66fd8080c7d8b65b1d6ccdd31'
-  TOKEN = '5c88b32edda7653c'
+  KEY = '66c59e2ee24553e7237259e30b4c17365681b95c'
+  TOKEN = 'a9ae4af3c3e80102'
 
 end

data/examples/donation_export.rb

@@ -0,0 +1,63 @@
+# *******************************************
+# This is a demo file to show usage.
+#
+# @package TheCity::Admin
+# @authors Robbie Lieb <robbie@onthecity.org>, Wes Hays <wes@onthecity.org>
+# ******************************************* 
+
+TCA_ENV = 'development' 
+THE_CITY_ADMIN_PATH = 'http://api.devthecity.org:9292' 
+key = '66c59e2ee24553e7237259e30b4c17365681b95c'
+token = 'a9ae4af3c3e80102'
+
+
+require 'ruby-debug'
+require File.dirname(__FILE__) + '/../lib/the_city_admin.rb'
+
+require File.dirname(__FILE__) + '/city_keys.rb'
+include CityKeys
+
+TheCity::AdminApi.connect(KEY, TOKEN)
+
+
+de_list = TheCity::DonationExportList.new
+de_list.each do |item|
+  puts "DonationExport: #{item.inspect}"
+end
+
+# de_list = TheCity::DonationExportList.new
+# de_list.each do |item|
+#   if item.delete 
+#     puts "DonationExport #{item.id} deleted"
+#   else
+#     puts "Unable to delete donation export #{item.id}: #{item.error_messages.join(', ')}"
+#   end
+# end
+
+# de_list = TheCity::DonationExportList.new
+# if de_list.empty?
+#   puts "No donation exports found"
+# else
+#   puts "Donation exports found"
+# end
+
+# donation_export = TheCity::DonationExport.new
+# if donation_export.save
+#   puts "Donation export created"
+# else
+#   puts "Failed to create donation export"
+# end
+
+
+# de_list = TheCity::DonationExportList.new
+# if de_list.empty?
+#   puts "No donation exports found"
+# else
+#   puts "Donation exports found"
+# end
+
+puts "------------------------------------"
+
+puts "####################################"
+
+

data/lib/api/donation_export.rb

@@ -0,0 +1,38 @@
+module TheCity
+
+  class DonationExport < ApiObject
+
+    tc_attr_accessor :id, 
+                     :state,
+                     :authenticated_s3_url,
+                     :created_at
+
+
+    # Loads the donation export by the specified ID.
+    #
+    # @param donation_export_id The ID of the donation export to load.
+    # @param options A hash of options for requesting data from the server.
+    #                :: donation_id is required    
+    #
+    # Returns a new {DonationExport} object.
+    def self.load_by_id(donation_export_id, options = {})
+      donation_reader = DonationExportReader.new(donation_export_id, options)
+      self.new(donation_reader.load_feed)
+    rescue
+      nil        
+    end     
+
+
+    # Constructor.
+    #
+    # @param json_data (optional) JSON data of the donation export.
+    def initialize(json_data = nil)
+      @writer_object = DonationExportWriter
+      initialize_from_json_object(json_data) unless json_data.nil?
+    end
+    
+  end
+
+end
+
+

data/lib/api/donation_export_list.rb

@@ -0,0 +1,63 @@
+module TheCity
+
+  class DonationExportList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :donation_id - The ID of the donation to load the addresses for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   DonationExportList.new({:donation_id => 12345})
+    #
+    #   DonationExportList.new({:donation_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      reader = options[:reader] || TheCity::DonationExportListReader.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
+    
+    
+    # Get the specified note.
+    #
+    # @param index The index of the note to get.
+    #
+    # @return [DonationExport]
+    def [](index)
+      DonationExport.new( @json_data['exports'][index] ) if @json_data['exports'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['exports'].each{ |export| yield( DonationExport.new(export) )}
+    end    
+  
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['exports'].empty?
+    end
+
+  end
+  
+end

data/lib/api/fund.rb

@@ -36,6 +36,7 @@ module TheCity
       elsif reader.is_a?(Hash)
         initialize_from_json_object(reader)
       end
+      @writer_object = FundWriter
     end
 
   end

data/lib/common.rb

@@ -50,12 +50,12 @@ module TheCity
     current_time = Time.now.to_i.to_s
     string_to_sign = current_time.to_s + method_request + url
 
-    unencoded_hmac = OpenSSL::HMAC.digest('sha256', TheCity::AdminApi::API_KEY, string_to_sign)
+    unencoded_hmac = OpenSSL::HMAC.digest('sha256', TheCity::AdminApi.api_key, string_to_sign)
     unescaped_hmac = Base64.encode64(unencoded_hmac).chomp
     hmac_signature = CGI.escape(unescaped_hmac)
 
     {'X-City-Sig' => hmac_signature,
-     'X-City-User-Token' => TheCity::AdminApi::API_TOKEN,
+     'X-City-User-Token' => TheCity::AdminApi.api_token,
      'X-City-Time' => current_time,
      'Accept' => 'application/vnd.thecity.admin.v1+json',
      'Content-Type' => 'application/json',

data/lib/readers/donation_export_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class DonationExportListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+      #@class_key = "groups_#{group_id}_exports"   
+      @url_data_path = "/donations/exports"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/readers/donation_export_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class DonationExportReader < ApiReader
+
+    # Constructor.
+    #
+    # @param donation_export_id The ID of the donation export to load.
+    # @param options A hash of options for requesting data from the server.
+    # @param cacher (optional) The CacheAdapter cacher to be used to cache data.
+    def initialize(donation_export_id, options = {}, cacher = nil)
+      #@class_key = "donation_export_#{donation_export_id}"   
+      @url_data_path = "/donations/exports/#{donation_export_id}"
+      @url_data_params = options
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/the_city_admin.rb

@@ -28,28 +28,14 @@ require File.dirname(__FILE__) + '/common.rb'
 module TheCity
 
   class AdminApi
-
-    attr_reader :api_key, :api_token
-
-
-    # Alias for calling the *new* method.
-    def self.connect(api_key, api_token)
-      self.new(api_key, api_token)
+    class << self
+      attr_reader :api_key, :api_token
     end
-
-
-    # Constructor.
-    #
-    # @param api_key The API key for the church.
-    # @param api_token The API token for the church.
-    def initialize(api_key, api_token)
-      raise TheCityExceptions::UnableToConnectToTheCity.new('Key and Token cannot be nil.') if api_key.nil? or api_token.nil?
-
-      # Create a constant for the churches API key.
-      TheCity::AdminApi::const_set(:API_KEY, api_key) unless defined?(API_KEY)
-
-      # Create a constant for the churches API Token.
-      TheCity::AdminApi::const_set(:API_TOKEN, api_token) unless defined?(API_TOKEN)
+    
+    def self.connect(admin_api_key, admin_api_token)
+      raise TheCityExceptions::UnableToConnectToTheCity.new('Key and Token cannot be nil.') if admin_api_key.nil? or admin_api_token.nil?
+      @api_key = admin_api_key
+      @api_token = admin_api_token
     end
 
   end

data/lib/writers/donation_export_writer.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class DonationExportWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json data to save.
+    def initialize(data)
+      if data[:id]
+        @url_action = :put
+        @url_data_path = nil # not implemented
+      else
+        @url_action = :post   
+        @url_data_path = '/donations/exports'   
+      end
+      @url_data_delete_path = "/donations/exports/#{data[:id]}" 
+
+      @url_data_params = data
+    end
+    
+  end
+
+end
+
+

data/lib/writers/fund_writer.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class FundWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json data to save.
+    def initialize(data)
+      if data[:id]
+        @url_action = :put
+        @url_data_path = "/funds/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/funds"   
+      end
+      @url_data_delete_path = "/funds/#{data[:id]}" 
+
+      @url_data_params = data
+    end
+    
+  end
+
+end
+
+

data/thecity_admin_api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   PROJECT_GEM = 'the-city-admin'
-  PROJECT_GEM_VERSION = '0.4.0'
+  PROJECT_GEM_VERSION = '0.5.0'
   
   s.name = PROJECT_GEM
   s.version = PROJECT_GEM_VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the-city-admin
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-17 00:00:00.000000000 Z
+date: 2013-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -49,6 +49,7 @@ files:
 - examples/addresses.rb
 - examples/barcodes_checkins.rb
 - examples/city_keys.rb
+- examples/donation_export.rb
 - examples/familes.rb
 - examples/groups.rb
 - examples/metrics.rb
@@ -66,6 +67,8 @@ files:
 - lib/api/checkin.rb
 - lib/api/checkin_list.rb
 - lib/api/donation.rb
+- lib/api/donation_export.rb
+- lib/api/donation_export_list.rb
 - lib/api/donation_list.rb
 - lib/api/family.rb
 - lib/api/family_member.rb
@@ -140,6 +143,8 @@ files:
 - lib/readers/api_reader.rb
 - lib/readers/checkin_list_reader.rb
 - lib/readers/checkin_reader.rb
+- lib/readers/donation_export_list_reader.rb
+- lib/readers/donation_export_reader.rb
 - lib/readers/donation_list_reader.rb
 - lib/readers/donation_reader.rb
 - lib/readers/family_reader.rb
@@ -187,7 +192,9 @@ files:
 - lib/readers/web_hook_list_reader.rb
 - lib/the_city_admin.rb
 - lib/writers/api_writer.rb
+- lib/writers/donation_export_writer.rb
 - lib/writers/family_writer.rb
+- lib/writers/fund_writer.rb
 - lib/writers/group_address_writer.rb
 - lib/writers/group_export_writer.rb
 - lib/writers/group_writer.rb