rescuegroups 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 bornfree
+
+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,83 @@
+This is Ruby wrapper for Rescuegroups API
+http://support.rescuegroups.org:8091/display/userguide/HTTP+API
+
+For now, as gem is not yet complete, please clone/fork the repo
+and bundle using the :path param in your Gemfile.
+
+## Usage
+
+First setup your api key
+```ruby
+Rescuegroups.configure do |config|
+  config.api_key = 'ABCD'
+end
+``` 
+Then create a client anywhere with object_type and object_action attributes.
+Your snake_case symbols are automatically camelcased within.
+```ruby
+client = Rescuegroups::Client.new :object_type => "animals", :object_action => "publicSearch"
+```
+
+If you wish to perform elevated actions like add or edit animal you will have to login.
+```ruby
+client.login(:username => "john", :password => "doe", :user_account => "0")
+```
+This will attach token and tokenHash to further requests
+
+### Search procedure
+
+Add filters. For example to search for an animal with animalID as 1234
+```ruby
+client.set_search_filter 'animalID', :eq, "1234"
+client.set_search_filter 'animalStatus', :eq, "Available" # Not required but adviced
+```
+
+To clear all filters do
+```ruby
+client.clear_search_filters
+```
+
+Specify the fields you need as an array
+```ruby
+client.set_search_fields ['animalName', 'animalID', 'animalBreed']
+```
+
+To clear all fields do
+```ruby
+client.clear_search_fields
+```
+
+Then, run the query and get the json
+```ruby  
+response = client.query
+```
+
+### Add/Edit animal procedure
+To add animal species(dog/cat/bird) and primary breed are compulsory
+First create a client and login
+```ruby
+client = Rescuegroups::Client.new :object_type => "animals", :object_action => "add" # or "edit"
+client.login(:username => "john", :password => "doe", :user_account => "0")
+```
+
+Then set the values of fields(snake_cased)
+```ruby
+client.set_value_fields(:animal_name => "Pepsi", :animal_species_id => "Dog", :animal_primary_breed_id => "123")
+```
+
+Send a query as usual and watch for response
+```ruby  
+response = client.query
+```
+
+
+For available object type and object actions refer to 
+http://support.rescuegroups.org:8091/display/userguide/HTTP+API+object+definitions
+
+## Contributing
+
+1. Fork it
+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,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.ruby_opts << "-rubygems"
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/build/.gitignore

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

data/build/Gemfile

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

data/build/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 bornfree
+
+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/build/README.md

@@ -0,0 +1,29 @@
+# Build
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'build'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install build
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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/build/Rakefile

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

data/build/build.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'build/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "build"
+  spec.version       = Build::VERSION
+  spec.authors       = ["bornfree"]
+  spec.email         = ["harsha.xg@gmail.com"]
+  spec.description   = %q{TODO: Write a gem description}
+  spec.summary       = %q{TODO: Write a gem summary}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/build/lib/build.rb

@@ -0,0 +1,5 @@
+require "build/version"
+
+module Build
+  # Your code goes here...
+end

data/build/lib/build/version.rb

@@ -0,0 +1,3 @@
+module Build
+  VERSION = "0.0.1"
+end

data/lib/rescuegroups.rb

@@ -0,0 +1,10 @@
+require "json"
+require "curb"
+require "rescuegroups/version"
+require "rescuegroups/configuration"
+require "rescuegroups/client"
+
+module Rescuegroups
+  extend Configuration
+end
+

data/lib/rescuegroups/client.rb

@@ -0,0 +1,139 @@
+module Rescuegroups
+  class Client
+
+    OPERATIONS = {  :eq => "equal",
+                    :ne => "notequal",
+                    :lt => "lessthan",
+                    :lte => "lessthanorequal",
+                    :gt => "greaterthan",
+                    :gte => "greaterthanorequal",
+                    :contains => "contains",
+                    :notcontains => "notcontains",
+                    :blank => "blank",
+                    :notblank => "notblank",
+                    :radius => "radius"}
+
+    attr_accessor :api_key, :object_type, :object_action, :search, :fields, :token, :token_hash, :values
+
+    def initialize(options={})
+      self.api_key = options[:api_key] || Rescuegroups.api_key
+      self.object_type = options[:object_type]
+      self.object_action = options[:object_action]
+      self.search = search_params
+      self.values = value_params
+      
+      raise ArgumentError, "Please provide object_type and object_action" if (self.object_type == nil or self.object_action == nil)
+    end
+
+    def login(options={})
+      main_options = { :username => options[:username],
+                       :password => options[:password],
+                       :account_number => options[:account_number],
+                       :action => "login"}
+      main_options = camelize(main_options)
+      response_object = Curl.post(Rescuegroups::Configuration::ENDPOINT, main_options.to_json)
+      response = JSON.parse(response_object.body_str)
+      if response["status"] == "ok"
+        self.token = response["data"]["token"]
+        self.token_hash = response["data"]["tokenHash"]
+        puts "Login successful. Token set as #{self.token} and token hash as #{self.token_hash}"
+        return true
+      else
+        puts "Login unsuccessful." + response["messages"]["generalMessages"]["messageText"]
+        return false
+      end
+    end  
+
+    def logged_in?
+      self.token && self.token_hash
+    end
+
+    def set_search_filter(field_name, operation, criteria)
+
+      filter ={ :field_name => field_name.to_s.split("_").each_with_index {|part,i| part.capitalize! unless i == 0}.join,
+                :operation => OPERATIONS[operation],
+                :criteria => criteria.to_s}
+      self.search["search"]["filters"] << camelize(filter)
+    end
+
+    def clear_search_filters
+      self.search["search"]["filters"] = []
+    end
+
+    def set_search_fields(fields)
+      self.search["search"]["fields"] = fields
+    end
+
+    def clear_search_fields
+      self.search["search"]["fields"] = []
+    end
+
+    def set_value_fields(fields)
+      self.values["values"] << camelize(fields)
+    end
+
+    def clear_value_fields
+      self.values["values"] = []
+    end
+
+    def query
+      response_object = Curl.post(Rescuegroups::Configuration::ENDPOINT, query_params.to_json)
+      @response = JSON.parse(response_object.body_str)
+    end
+
+    def query_params
+      if logged_in?
+        main_options = {:token => self.token,
+                        :token_hash => self.token_hash, 
+                        :object_type => self.object_type,
+                        :object_action => self.object_action}
+      else
+        main_options = {:apikey => self.api_key, 
+                        :object_type => self.object_type,
+                        :object_action => self.object_action}
+      end
+
+      if self.search["search"]["filters"].present?
+        main_options.merge!(self.search)
+      elsif self.values["values"].present?
+        main_options.merge!(self.values)
+      end
+      main_options = camelize(main_options)
+      return main_options
+    end
+
+    def search_params
+      camelize({:search => 
+        {
+          :result_start => 0,
+          :result_limit => 10,
+          :result_sort => "animalID",
+          :result_order => "asc",
+          :fields => [],
+          :filters => []
+        }
+      })
+    end
+
+    def value_params
+      camelize({:values =>[] })
+    end
+
+    def camelize(snake_hash)
+      camel_hash = {}
+      snake_hash.each do |k,v|
+        camelized_key = k.to_s.split("_").each_with_index do |part,i| 
+          next if i == 0
+          (part == "id")? part.upcase! : part.capitalize!
+        end.join
+        if v.class ==  Hash
+          camel_hash[camelized_key] = camelize(v)
+        else
+         camel_hash[camelized_key] = v
+        end
+      end
+      return camel_hash
+    end
+
+  end
+end

data/lib/rescuegroups/configuration.rb

@@ -0,0 +1,23 @@
+module Rescuegroups
+  module Configuration
+
+    ENDPOINT     = 'https://api.rescuegroups.org/http/json'
+    API_KEY      = nil
+    CONTENT_TYPE = "application/json"
+
+    attr_accessor :api_key
+
+    def self.extended(base)
+      base.reset
+    end
+ 
+    def reset
+      self.api_key = API_KEY
+    end
+
+    def configure
+      yield self
+    end
+    
+  end
+end

data/lib/rescuegroups/version.rb

@@ -0,0 +1,3 @@
+module Rescuegroups
+  VERSION = "0.0.1"
+end

data/rescuegroups.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rescuegroups/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rescuegroups"
+  spec.version       = Rescuegroups::VERSION
+  spec.authors       = ["bornfree"]
+  spec.email         = ["harsha.xg@gmail.com"]
+  spec.description   = "Ruby wrapper for Rescuegroups API"
+  spec.summary       = "Ruby wrapper for talking to the Rescuegroups API"
+  spec.homepage      = "https://github.com/bornfree/rescuegroups"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "curb"
+  spec.add_development_dependency "json"
+  spec.add_development_dependency "pry-rails"
+end

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'rescuegroups'
+require 'minitest/spec'
+require 'minitest/autorun'

data/test/rescuegroups/client_test.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+describe 'client' do 
+
+  describe '.api_key' do
+    it 'should be able to set api key when provided' do
+      client = Rescuegroups::Client.new :api_key => "123", :object_type => "animals", :object_action => "define"
+      client.api_key.must_equal "123"
+    end
+
+    it 'should be able to revert to default when api key when created' do
+      client = Rescuegroups::Client.new :object_type => "animals", :object_action => "define"
+      client.api_key.must_equal Rescuegroups::Configuration::API_KEY
+    end
+
+    it 'should have all three values of apikey, objecttype and objectaction' do
+      client = Rescuegroups::Client.new :object_type => "animals", :object_action => "define"
+    end
+
+    it 'should run a query and return something' do
+      client = Rescuegroups::Client.new :object_type => "animals", :object_action => "define"
+      client.filter :age, :lt, 5
+      client.query != nil
+    end 
+
+end
+
+end

data/test/rescuegroups/configuration_test.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+describe 'configuration'  do
+
+  describe '.api_key' do
+    it 'should have an api key' do
+      Rescuegroups.api_key.must_equal Rescuegroups::Configuration::API_KEY
+    end
+  end
+
+  after do 
+    Rescuegroups.reset    
+  end
+
+  describe '.configure' do
+    it 'should configure api_key' do
+      Rescuegroups.configure do |config|
+        config.send("api_key=", "123")
+        Rescuegroups.send("api_key").must_equal "123"
+      end
+    end
+  end
+
+end

data/test/rescuegroups/rescuegroups_test.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+describe Rescuegroups do 
+  it 'should have a version' do
+    Rescuegroups::VERSION.wont_be_nil
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: rescuegroups
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- bornfree
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  name: curb
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  name: json
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  name: pry-rails
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for Rescuegroups API
+email:
+- harsha.xg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- build/.gitignore
+- build/Gemfile
+- build/LICENSE.txt
+- build/README.md
+- build/Rakefile
+- build/build.gemspec
+- build/lib/build.rb
+- build/lib/build/version.rb
+- lib/rescuegroups.rb
+- lib/rescuegroups/client.rb
+- lib/rescuegroups/configuration.rb
+- lib/rescuegroups/version.rb
+- rescuegroups.gemspec
+- test/helper.rb
+- test/rescuegroups/client_test.rb
+- test/rescuegroups/configuration_test.rb
+- test/rescuegroups/rescuegroups_test.rb
+homepage: https://github.com/bornfree/rescuegroups
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for talking to the Rescuegroups API
+test_files:
+- test/helper.rb
+- test/rescuegroups/client_test.rb
+- test/rescuegroups/configuration_test.rb
+- test/rescuegroups/rescuegroups_test.rb