volunteermatch 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05fce463f09212a4f232e51426b0f2f2f86f159b
+  data.tar.gz: 3e6acefe9f38c2c0daf3be8183b699780b71f196
+SHA512:
+  metadata.gz: 3d870c1af980855c6464df22a070ba55e2bb3f585d691b249d73b7410c4e80051949e8d02ad0013494641f25281313265393efa8dcba0a7dbc7c3c7c251cf19a
+  data.tar.gz: 29f869e4a5c19d577d6ba02ac64810ba30d281db2929f386c311785bd89343dc3c806716ddbe9a06239ff4e4200b21ba5806858a36e0ca0075070482c7037d37

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+.rspec_status
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+before_install: gem install bundler -v 1.14.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at evanscloud@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2017 Evan Ng
+
+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,91 @@
+# The VolunteerMatch Public-Use API Gem
+
+VolunteerMatch is a lightweight Ruby wrapper that queries VolunteerMatch's Public-Use API for searching information on nonprofit organizations and active volunteering opportunities.
+
+This gem is inspired by the Ruby API example provided in the [vm-contrib repo](https://github.com/volunteermatch/vm-contrib). Queries are configured based on the attributes applied and return a collection of JSON results.
+
+The Official documentation on using the API can be found at [VolunteerMatch.org](http://cdn.volunteermatch.org/www/legal/VM-Public-use-API-user-manual.pdf).
+
+### Before Continuing
+
+To use VolunteerMatch's Public-Use API, you need to be validated for full access. Complete an online application [here](https://www.volunteermatch.org/legal/publicuseapi) in order to get approved for a unique Public-Use key. Until then, you are only able to test `helloWorld` calls.
+
+## Getting Started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'volunteermatch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install volunteermatch
+
+
+## Setting Your API Key
+
+Concealing your API username and key is important. I recommend using [dotenv](https://github.com/bkeepers/dotenv) to do so.
+
+```ruby
+client = Volunteermatch::Client.new('username', 'key')
+```
+
+After setting a `client`, you are able to access all methods below.
+
+## Basic Usage Examples
+
+**Test API Connectivity**
+```ruby
+vm = client.test("John")
+vm.result                   #=> "Hello John!"
+```
+
+**Get API Key Status**
+```ruby
+client.key_status
+```
+
+**Search Opportunities (location required)**
+```ruby
+client.search_opportunities(location: "New York", orgNames: ["red cross"], fieldsToDisplay: ["title", "description"])
+```
+
+**Search Organizations (location required)**
+```ruby
+client.search_organizations(location: "San Francisco", categoryIds: [23], fieldsToDisplay: ["name", "mission"])
+```
+
+**Get Metadata (defaults to current version)**
+```ruby
+client.metadata
+```
+
+**Get Service Status**
+```ruby
+client.service_status
+```
+
+## API Access Agreement
+
+All data obtained through this gem belongs to VolunteerMatch. Please review the [Public-Use API Access Agreement](http://cdn.volunteermatch.org/www/legal/Public-Use%20API%20Access%20Agreement.pdf) for all terms, limitations and restrictions.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Suggestions, bug reports and pull requests are encouraged for those who would like to take part in improving this gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org).
+
+## License
+
+Copyright (c) 2017, Evan Ng
+
+The VolunteerMatch gem is available as open source under the terms of the [MIT license](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "volunteermatch"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/volunteermatch.rb

@@ -0,0 +1,2 @@
+require 'volunteermatch/version'
+require 'volunteermatch/client'

data/lib/volunteermatch/api/hello_world.rb

@@ -0,0 +1,9 @@
+module Volunteermatch
+  module API
+    module HelloWorld
+      def test(name)
+        call(:helloWorld, {:name => name}.to_json)
+      end
+    end
+  end
+end

data/lib/volunteermatch/api/key_status.rb

@@ -0,0 +1,9 @@
+module Volunteermatch
+  module API
+    module KeyStatus
+      def key_status
+        call(:getKeyStatus, {}.to_json)
+      end
+    end
+  end
+end

data/lib/volunteermatch/api/metadata.rb

@@ -0,0 +1,9 @@
+module Volunteermatch
+  module API
+    module Metadata
+      def metadata(version = nil)
+        call(:getMetaData, {:version => version}.to_json)
+      end
+    end
+  end
+end

data/lib/volunteermatch/api/search_opportunities.rb

@@ -0,0 +1,11 @@
+module Volunteermatch
+  module API
+    module SearchOpportunities
+      def search_opportunities(parameters = {})
+        raise ArgumentError, 'location needs to be defined' if parameters[:location].nil? || parameters[:location].empty?
+        parameters[:location] = parameters[:location] || nil
+        call(:searchOrganizations, parameters.to_json)
+      end
+    end
+  end
+end

data/lib/volunteermatch/api/search_organizations.rb

@@ -0,0 +1,11 @@
+module Volunteermatch
+  module API
+    module SearchOrganizations
+      def search_organizations(parameters = {})
+        raise ArgumentError, 'location needs to be defined' if parameters[:location].nil? || parameters[:location].empty?
+        parameters[:location] = parameters[:location] || nil
+        call(:searchOrganizations, parameters.to_json)
+      end
+    end
+  end
+end

data/lib/volunteermatch/api/service_status.rb

@@ -0,0 +1,9 @@
+module Volunteermatch
+  module API
+    module ServiceStatus
+      def service_status
+        call(:getServiceStatus, {}.to_json)
+      end
+    end
+  end
+end

data/lib/volunteermatch/client.rb

@@ -0,0 +1,52 @@
+require 'base64'
+require 'digest/sha2'
+require 'net/http'
+require 'uri'
+require 'json'
+require 'ostruct'
+
+require 'volunteermatch/api/hello_world'
+require 'volunteermatch/api/key_status'
+require 'volunteermatch/api/metadata'
+require 'volunteermatch/api/service_status'
+require 'volunteermatch/api/search_organizations'
+require 'volunteermatch/api/search_opportunities'
+
+module Volunteermatch
+  class Client
+    attr_accessor :api_username, :api_key
+
+    include Volunteermatch::API::HelloWorld
+    include Volunteermatch::API::KeyStatus
+    include Volunteermatch::API::Metadata
+    include Volunteermatch::API::ServiceStatus
+    include Volunteermatch::API::SearchOrganizations
+    include Volunteermatch::API::SearchOpportunities
+
+    def initialize(api_username, api_key)
+      raise ArgumentError, 'username and key need to be defined' if api_username.nil? || api_username.empty? || api_key.nil? || api_key.empty?
+      @api_username   = api_username
+      @api_key        = api_key
+    end
+
+    protected
+
+    def call(action, json_query)
+      nonce           = Digest::SHA2.hexdigest(rand.to_s)[0, 20]
+      creation_time   = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S%z")
+      password_digest = Base64.encode64(Digest::SHA2.digest(nonce + creation_time + @api_key)).chomp
+      url             = URI.parse("http://www.volunteermatch.org/api/call?action=#{action.to_s}&query=" + URI.encode(json_query))
+
+      req             = Net::HTTP::Get.new(url.request_uri)
+
+      req.add_field('Content-Type', 'application/json')
+      req.add_field('Authorization', 'WSSE profile="UsernameToken"')
+      req.add_field('X-WSSE', 'UsernameToken Username="' + @api_username + '", PasswordDigest="' + password_digest + '", ' +
+          'Nonce="' + nonce + '", Created="' + creation_time + '"')
+
+      res             = Net::HTTP.new(url.host, url.port).start { |http| http.request(req) }
+      raise "HTTP error code #{res.code}" unless res.code == "200"
+      OpenStruct.new(JSON.parse res.body)
+    end
+  end
+end

data/lib/volunteermatch/version.rb

@@ -0,0 +1,3 @@
+module Volunteermatch
+  VERSION = "0.3.1"
+end

data/volunteermatch.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'volunteermatch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "volunteermatch"
+  spec.version       = Volunteermatch::VERSION
+  spec.authors       = ["Evan Ng"]
+  spec.email         = ["evan.ng@outlook.com"]
+
+  spec.summary       = %q{A Ruby wrapper for VolunteerMatch's Public-Use API.}
+  spec.description   = %q{A lightweight Ruby wrapper that queries VolunteerMatch's Public-Use API for searching information on nonprofit organizations and active volunteering opportunities.}
+  spec.homepage      = "https://github.com/evanscloud/vm_public_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.3"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: volunteermatch
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Evan Ng
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: A lightweight Ruby wrapper that queries VolunteerMatch's Public-Use API
+  for searching information on nonprofit organizations and active volunteering opportunities.
+email:
+- evan.ng@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/volunteermatch.rb
+- lib/volunteermatch/api/hello_world.rb
+- lib/volunteermatch/api/key_status.rb
+- lib/volunteermatch/api/metadata.rb
+- lib/volunteermatch/api/search_opportunities.rb
+- lib/volunteermatch/api/search_organizations.rb
+- lib/volunteermatch/api/service_status.rb
+- lib/volunteermatch/client.rb
+- lib/volunteermatch/version.rb
+- volunteermatch.gemspec
+homepage: https://github.com/evanscloud/vm_public_api
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for VolunteerMatch's Public-Use API.
+test_files: []