luminate 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODQ1ZTc2ZWYyZDU1ODkxZWVmMmI5NzI3NzM1MWQwYTAwNTIxZDBjYg==
+  data.tar.gz: !binary |-
+    Mjk3NjYxYzE5ZWI5NjYzNjVlMjdkZDZmMzAyOGFiMDhmNGFhNGFkYg==
+SHA512:
+  metadata.gz: !binary |-
+    N2Q2MTUyZWUyZWM5NTk0NmIwNWRiMDdlODZmNTUzNmRmMjQ4Y2EyMDIwODMy
+    MGJmOGVmOWIyYzk2MjMwNWQ5NGU2YmQzODhkNGQ2ODg1MjRiZTIxMzk5OWNl
+    NzBhM2JkOGJmZDM2MDhhMzRmZDQ3ZGE5M2FlYjk2OTRiYTZkMzE=
+  data.tar.gz: !binary |-
+    OWY0NjU2MzkyMmI5YzdiYWY1NTZmZjYzMDc3OTBkYmFhMzQ5ODk3NWE5MmI2
+    ZGIzMzQ5NzhjYzI1NzgyYTMyNjVhZDQwZTMwMWNlM2U1MWM2NzUzZTUwNDA2
+    MmJlY2EyNDc5NzE2ZDllYWE4NjZkOGFlNjEyODE3N2UyMTFiZDk=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.ruby-*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in luminate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Spike Ilacqua
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# Luminate
+
+This gem provides Ruby bindings for the
+[Luminate Online Server APIs](http://open.convio.com/api/#main).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'luminate'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install luminate
+
+## Usage
+
+Require the gem (or let bundler do it for you) and configure as
+follows:
+
+```ruby
+require 'luminate'
+Luminate.configure do |config|
+  config.url          = 'https://secure3.convio.net'
+  config.organization = 'your-organization'
+  config.api_key      = 'your-api-key'
+  config.api_login    = 'your-api-login-name'
+  config.api_password = 'your-api-password'
+end
+```
+
+The URL is typically https://secure2.convio.net or
+https://secure3.convio.net. The organization is the short name Convio
+uses to identify you. Both of these can be extracted from the URL of
+your Admin panel:
+
+```
+https://secure2.convio.net/<organization>/admin...
+```
+
+You will need to configure the API key, login name, and password in
+the Admin. Some endpoints are disabled by default, so be sure to check
+the documentation.
+
+The bindings are implemented as class level methods with one class per
+API. The method names are underscorized version of Luminate's names.
+
+To test your settings try the
+[Constituent isEmailValid method](http://open.convio.com/api/#constituent_api.isEmailValid_method.html) (which simply checks the pattern of an email for validity):
+
+```ruby
+constituent = Luminate::Constituent
+response = constituent.is_email_valid(email: 'spike@example.com')
+ => {"isEmailValidResponse"=>{"valid"=>"true"}}
+```
+
+The response value is a [Map](https://github.com/ahoward/map), a
+hash-like object that also provides methods to access the values.
+
+```ruby
+response['isEmailValidResponse']
+ => {"valid"=>"true"}
+ response.isEmailValidResponse
+ => {"valid"=>"true"}
+ response.isEmailValidResponse.valid
+ => "true"
+```
+
+## Currently implemented methods
+
+See (Contributing)[#contributing] for how to add more.
+
+* [Constituent: getUser](http://open.convio.com/api/#constituent_api.getUser_method.html)
+* [Constituent: getUserTransactions](http://open.convio.com/api/#constituent_api.getUserTransactions_method.html)
+* [Constituent: isEmailValid](http://open.convio.com/api/#constituent_api.isEmailValid_method.html)
+* [Donation: addOfflineDonation](http://open.convio.com/api/#donation_api.addOfflineDonation_method.html)
+
+## Contributing
+
+This is version 0.1.0, I have only implement endpoints I'm actually
+using and have (manually) tested. Since the interface is simple and
+consistent, endpoints can be implement with a bit of
+meta-programming. ```Luminate::Base``` provides a helper method,
+```def_endpoints``` to do this. It takes the API's *Server Servlet*
+name and the list of methods. See
+[lib/luminate/constituent.rb](https://github.com/spikex/luminate/blob/master/lib/luminate/constituent.rb)
+for an example.
+
+Got changes?
+
+1. Fork it ( http://github.com/spike/luminate/fork )
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/luminate.rb

@@ -0,0 +1,20 @@
+require 'luminate/version'
+require 'luminate/config'
+require 'luminate/base'
+
+module Luminate
+
+  autoload :Donation,    'luminate/donation'
+  autoload :Constituent, 'luminate/constituent'
+
+  class << self
+    attr_accessor :config
+  end
+
+  self.config ||= Config.new
+
+  def self.configure
+    yield config
+    config
+  end
+end

data/lib/luminate/base.rb

@@ -0,0 +1,50 @@
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'multi_json'
+require 'map'
+
+module Luminate
+  class Base
+
+    def self.def_endpoints(api,*endpoints)
+      endpoints.each do |endpoint|
+        method_name = endpoint.gsub(/(.)([A-Z])/,'\1_\2').downcase
+        define_singleton_method method_name do |params|
+          send_request(api,params.merge({method: endpoint}))
+        end
+      end
+    end
+
+    def self.send_request(api = '', params = {})
+      raise 'No API specified' if api.empty?
+      raise 'No method specified' if params[:method].nil?
+
+      config = Luminate.config
+      params.merge!(response_format: 'json',
+                    v: '1.0',
+                    api_key: config.api_key,
+                    login_name: config.api_login,
+                    login_password: config.api_password)
+
+      url = URI.join(config.url,"#{config.organization}/",'site/',api)
+
+      http = Net::HTTP.new(url.host, url.port)
+
+      if url.port == 443
+        http.use_ssl = true
+      end
+
+      req = Net::HTTP::Post.new(url.path)
+      req.set_form_data(params)
+      res = http.start { |http| http.request(req) }
+      Map.for(parse_response(res.body))
+    end
+
+    # Converts the API response to a Hash
+    def self.parse_response(raw)
+      return {} if raw.to_s.empty?
+      ::MultiJson.decode(raw)
+    end
+  end
+end

data/lib/luminate/config.rb

@@ -0,0 +1,9 @@
+module Luminate
+  class Config
+    attr_accessor :url
+    attr_accessor :organization
+    attr_accessor :api_key
+    attr_accessor :api_login
+    attr_accessor :api_password
+  end
+end

data/lib/luminate/constituent.rb

@@ -0,0 +1,5 @@
+module Luminate
+  class Constituent < Base
+    def_endpoints('SRConsAPI','getUser','isEmailValid','getUserTransactions')
+  end
+end

data/lib/luminate/donation.rb

@@ -0,0 +1,5 @@
+module Luminate
+  class Donation < Base
+    def_endpoints('SRDonationAPI','addOfflineDonation')
+  end
+end

data/lib/luminate/version.rb

@@ -0,0 +1,3 @@
+module Luminate
+  VERSION = "0.1.0"
+end

data/luminate.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'luminate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "luminate"
+  spec.version       = Luminate::VERSION
+  spec.authors       = ["Spike Ilacqua"]
+  spec.email         = ["spike@indra.com"]
+  spec.summary       = %q{Ruby Gem for accessing the Convio's Luminate Online Server APIs}
+  spec.description   = %q{Access the Convio's Luminate Online Server APIs http://open.convio.com/api}
+  spec.homepage      = "https://github.com/spike/luminate"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'multi_json'
+  spec.add_runtime_dependency 'map'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: luminate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Spike Ilacqua
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: map
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Access the Convio's Luminate Online Server APIs http://open.convio.com/api
+email:
+- spike@indra.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/luminate.rb
+- lib/luminate/base.rb
+- lib/luminate/config.rb
+- lib/luminate/constituent.rb
+- lib/luminate/donation.rb
+- lib/luminate/version.rb
+- luminate.gemspec
+homepage: https://github.com/spike/luminate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby Gem for accessing the Convio's Luminate Online Server APIs
+test_files: []