sigimera 0.0.1.rc2 → 0.0.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sigimera (0.0.1.rc2)
+    sigimera (0.0.1)
       json
       nokogiri
 

data/README.md

@@ -1,25 +1,38 @@
 Sigimera Client
 ===============
 
-This repository includes a ruby client library for the REST API under http://api.sigimera.org.
+[![Build
+Status](https://secure.travis-ci.org/Sigimera/sigimera-ruby-client.png?branch=master)](https://travis-ci.org/Sigimera/sigimera-ruby-client) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/Sigimera/sigimera-ruby-client)
+
+The following ruby gem encapsulates access to the Sigimera REST API under
+http://api.sigimera.org. It includes the needed SSL certificate for the
+HTTPS connections and a detailed documentation. This library will be
+developed in parallel to the API.
 
 
 Installation
 ------------
 
-Install _sigimera_ manually from command line:
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sigimera'
+```
+
+And then execute:
 
 ```sh
-gem install sigimera
+$ bundle
 ```
 
-Add _sigimera_ to your Gemfile:
+Or install it yourself as:
 
-```ruby
-gem 'sigimera'
+```sh
+$ gem install sigimera
 ```
 
 
+
 Usage
 -----
 
@@ -33,11 +46,16 @@ irb
 >> puts Sigimera::Client.get_api_version
 >> puts Sigimera::Client.get_public_crises
 >> puts Sigimera::Client.get_public_rss_feed
+>> puts Sigimera::Client.get_auth_token("johndoe@example.org", "verySecretPassword")
 
 # see http://api.sigimera.org/dashboard
 >> client = Sigimera::Client.new("YourSecretToken")
+or
+# The username and password are NOT stored, but only used to fetch an
+# authentication token
+>> client = Sigimera::Client.new(username = "johndoe@example.org", password = "verySecretPassword")
 >> puts client.get_latest_crises
->> puts client.get_latest_crises(type = "earthquakes")
+>> puts client.get_latest_crises({ :type => "earthquakes" })
 >> puts client.get_crises_stat
 >> puts client.get_user_stat
 ```
@@ -54,6 +72,7 @@ export AUTH_TOKEN=YourSecretToken
 rake spec
 ```
 
+
 API Documentation
 -----------------
 

data/lib/sigimera/client.rb

@@ -1,16 +1,16 @@
+# encoding: UTF-8
 require "json"
 require "nokogiri"
+require "base64"
 
 module Sigimera
     # The main class that could be used to access the REST API
     class Client
         include Sigimera::HttpHelper
 
-        # The authentication token that is used for the API calls.
-        attr_reader :auth_token
-
-        def initialize(auth_token = nil)
-            @auth_token = auth_token
+        def initialize(auth_token = nil, username = nil, password = nil)
+            @auth_token = auth_token if auth_token
+            @auth_token = self.get_auth_token(username, password) if username and password
         end
 
         # This method returns current API version. For this purpose
@@ -43,31 +43,63 @@ module Sigimera
             Nokogiri::XML(response.body) if response
         end
 
+
+        # This method returns an authentication token. If the auth_token
+        # exists it is returned, otherwise a new one is created.
+        #
+        # @param [String] username The username (email) that is used for the basic authentication
+        # @param [String] password The password that is used for the basic authentication
+        # @return [String] The authentication token as string
+        def self.get_auth_token(username, password)
+            basic_hash = Base64.strict_encode64("#{username}:#{password}")
+            client = Sigimera::Client.new
+            response = client.post("/v1/tokens.json", basic_hash)
+            json = JSON.parse response.body if response
+            json['auth_token'].to_s if json and json['auth_token']
+        end
+
         # This method returns the latest 10 crises.
         #
-        # @param [String] type The crises type, e.g. earthquake, flood, cyclone, volcanoe
+        # @param [String] params A hash that contains the http parameters for the call, e.g. { :type => "earthquake", :level => "red", :output => "short" }
         # @return [Array] Returns an array of crises objects in JSON
-        def get_latest_crises(type = nil)
+        def get_latest_crises(params = nil)
             endpoint = "/v1/crises.json?auth_token=#{@auth_token}"
-            endpoint += "&type=#{type}" if type
+            endpoint += "&#{URI.encode_www_form params}" if params
+            response = self.get(endpoint.to_s)
+            JSON.parse response.body if response and response.body
+        end
+
+        # This method returns a single crisis.
+        #
+        # @param [String] identifier A unique crisis identifier
+        # @return [Hash] The single crisis as JSON object
+        def get_crisis(identifier, params = nil)
+            return nil if identifier.nil? or identifier.empty?
+            endpoint = "/v1/crises/#{identifier}.json?auth_token=#{@auth_token}"
+            endpoint += "&#{URI.encode_www_form params}" if params
             response = self.get(endpoint)
-            JSON.parse response.body if response
+            JSON.parse response.body if response and response.body
         end
 
         # This method returns statistic information about the crises.
-        # 
+        #
         # @return [Array] Returns the crises statistic as JSON object
         def get_crises_stat
             response = self.get("/v1/stats/crises.json?auth_token=#{@auth_token}")
-            JSON.parse response.body if response
+            JSON.parse response.body if response and response.body
         end
 
         # This method returns statistic information about user.
-        # 
+        #
         # @return [Array] Returns the user statistic as JSON object
         def get_user_stat
             response = self.get("/v1/stats/users.json?auth_token=#{@auth_token}")
-            JSON.parse response.body if response
+            JSON.parse response.body if response and response.body
         end
+
+        private
+        # The authentication token that is used for the API calls.
+        attr_reader :auth_token
+
     end
 end

data/lib/sigimera/http_helper.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require "net/http"
 
 module Sigimera
@@ -18,6 +19,22 @@ module Sigimera
             http.request(req)
         end
 
+        # POST endpoint
+        #
+        # @param [String] endpoint The endpoint that should be called.
+        # @param [String] basic_hash Base64.strict_encode64("username:password")
+        # @return [Net::HTTPResponse] The HTTP response object
+        def post(endpoint, basic_hash = nil)
+            uri, http = get_connection(endpoint)
+
+            req = Net::HTTP::Post.new("#{uri.path}?#{uri.query}")
+            req.add_field("Content-Type", "application/json")
+            req.add_field("User-Agent", "Sigimera Ruby Client v#{Sigimera::VERSION}")
+            req.add_field("Authorization", "Basic #{basic_hash}") if basic_hash
+
+            http.request(req)
+        end
+
         # HEAD endpoint
         #
         # @param [String] endpoint The endpoint that should be called.
@@ -44,8 +61,6 @@ module Sigimera
                 http.ca_file = CACERT_FILE
                 http.verify_mode = OpenSSL::SSL::VERIFY_PEER
                 http.verify_depth = 5
-            else
-                raise "Please use a secure SSL connection and the right root certificate. If you experience problems please contact support@sigimera.org."
             end
 
             return uri, http

data/lib/sigimera/version.rb

@@ -1,9 +1,6 @@
+# encoding: UTF-8
 module Sigimera
-    # Part of the Sigimera Platform
-    #
-    # Author::      Alex Oberhauser (mailto:alex.oberhauser@sigimera.org)
-    # Copyright::   Copyright (c) 2012 Sigimera
-    # License::     Closed Source
+    # Module that encapsulates the version number.
     module VERSION
         # The major version number that changes only if incompatibility with
         # the previous version was introduced.
@@ -16,7 +13,7 @@ module Sigimera
         TINY  = 1
 
         # The extra string marks the version as beta, alpha, rcX, ...
-        EXTRA = "rc2"
+        EXTRA = nil
 
         # Concatenates the version to a point separated string
         STRING = [MAJOR, MINOR, TINY].join('.')

data/sigimera.gemspec

@@ -1,24 +1,26 @@
-$:.push File.expand_path("../lib", __FILE__)
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "sigimera/version"
 
-Gem::Specification.new do |s|
-    s.name          = "sigimera"
-    s.version       = Sigimera::VERSION
-    s.authors       = [ "Alex Oberhauser" ]
-    s.email         = [ "alex.oberhauser@sigimera.org" ]
-    s.licenses      = [ "MIT" ]
-    s.homepage      = "https://github.com/Sigimera/sigimera-ruby-client"
-    s.summary       = "This is a ruby library that encapsulates access to the Sigimera REST API."
-    s.description   = "This is a ruby library that encapsulates access to the Sigimera REST API."
-    s.files         = `git ls-files`.split("\n")
-    s.require_paths = [ "lib" ]
+Gem::Specification.new do |gem|
+    gem.name          = "sigimera"
+    gem.version       = Sigimera::VERSION
+    gem.authors       = [ "Alex Oberhauser" ]
+    gem.email         = [ "alex.oberhauser@sigimera.org" ]
+    gem.licenses      = [ "MIT" ]
+    gem.homepage      = "https://github.com/Sigimera/sigimera-ruby-client"
+    gem.summary       = "This is the official ruby library for the Sigimera REST API."
+    gem.description   = "This is the official ruby library for the Sigimera REST API. It encapsulates the authentication process in a secure way and simplifies the access to the Crises Information Platform."
+    gem.files         = `git ls-files`.split("\n")
+    gem.require_paths = [ "lib" ]
 
-    s.add_runtime_dependency            "json"
-    s.add_runtime_dependency            "nokogiri"  # XML Parsing
+    gem.add_runtime_dependency            "json"
+    gem.add_runtime_dependency            "nokogiri"  # XML Parsing
 
-    s.add_development_dependency "rake"
-    s.add_development_dependency "rspec"
-    s.add_development_dependency "spork"
-    s.add_development_dependency "simplecov"
+    gem.add_development_dependency "rake"
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "spork"
+    gem.add_development_dependency "simplecov"
 end

data/spec/api/client_crises_spec.rb

@@ -0,0 +1,125 @@
+# encoding: UTF-8
+require "spec_helper"
+
+describe Sigimera::Client do
+
+	before(:all) do
+		auth_token = ENV['AUTH_TOKEN']
+        if auth_token
+            @client = Sigimera::Client.new(auth_token = auth_token)
+        else
+            pending "Plese specify ENV['AUTH_TOKEN']"
+        end
+	end
+
+    it "#get_latest_crises" do
+        crises = @client.get_latest_crises
+        crises.class.should eql(Array)
+        crises.size.should == 10
+        crises.each do |crisis|
+        crisis.class.should eql(Hash)
+            crisis['_id'].class.should eql(String)
+            crisis['_id'].should_not be_empty
+        end
+    end
+
+    it "#get_latest_crises({ :type => 'earthquakes' })" do
+        sleep 1 # Respect the courtesy limit and wait for one second
+        crises =  @client.get_latest_crises({ :type => "earthquakes" })
+        crises.class.should eql(Array)
+        crises.size.should == 10
+        crises.each do |crisis|
+            crisis['dc_subject'].first.should eql("earthquake")
+            crisis.class.should eql(Hash)
+            crisis['_id'].class.should eql(String)
+            crisis['_id'].should_not be_empty
+        end
+    end
+
+    it "#get_latest_crises({ :type => 'floods' })" do
+        sleep 1 # Respect the courtesy limit and wait for one second
+        crises = @client.get_latest_crises({ :type => "floods" })
+        crises.class.should eql(Array)
+        crises.size.should == 10
+        crises.each do |crisis|
+            crisis['dc_subject'].first.should eql("flood")
+            crisis.class.should eql(Hash)
+            crisis['_id'].class.should eql(String)
+            crisis['_id'].should_not be_empty
+        end
+    end
+
+    it "#get_latest_crises({ :type => 'cyclones' })" do
+        sleep 1 # Respect the courtesy limit and wait for one second
+        crises = @client.get_latest_crises({ :type => "cyclones" })
+        crises.class.should eql(Array)
+        crises.size.should == 10
+        crises.each do |crisis|
+            crisis['dc_subject'].sort.last.should eql("tropical cyclones")
+            crisis.class.should eql(Hash)
+            crisis['_id'].class.should eql(String)
+            crisis['_id'].should_not be_empty
+        end
+    end
+
+    it "#get_latest_crises({ :type => 'volcanoes' })" do
+        sleep 1 # Respect the courtesy limit and wait for one second
+        crises = @client.get_latest_crises({ :type => "volcanoes" })
+        crises.class.should eql(Array)
+        crises.size.should > 1
+        crises.each do |crisis|
+            crisis.class.should eql(Hash)
+            crisis['_id'].class.should eql(String)
+            crisis['_id'].should_not be_empty
+        end
+    end
+
+    it "#get_latest_crises({ :type => 'volcanoes', :output => 'short' })" do
+        sleep 1 # Respect the courtesy limit and wait for one second
+        crises = @client.get_latest_crises({ :type => "volcanoes", :output => "short" })
+        crises.class.should eql(Array)
+        crises.size.should > 1
+        crises.each do |crisis|
+            crisis.class.should eql(Hash)
+            crisis['_id'].class.should eql(String)
+            crisis['_id'].should_not be_empty
+        end
+    end
+
+    it "#get_latest_crises({ :type => 'not_available' })" do
+        sleep 1 # Respect the courtesy limit and wait for one second
+        crises = @client.get_latest_crises({ :type => "not_available" })
+        crises.class.should eql(NilClass)
+    end
+
+    it "#get_crisis(identifier)" do
+        sleep 1 # Respect the courtesy limit and wait for one second
+        id = "a8763f7e2c432ebe897a68706dcf8dd49243774d"
+        crisis = @client.get_crisis(id)
+        crisis.class.should eql(Hash)
+        crisis['_id'].should eql(id)
+        crisis['dc_title'].should eql("Green flood alert in Australia")
+        crisis['dc_subject'].class.should eql(Array)
+        crisis['dc_subject'].size.should > 0
+
+        sleep 1 # Respect the courtesy limit and wait for one second
+        crisis = @client.get_crisis("")
+        crisis.class.should eql(NilClass)
+
+        sleep 1 # Respect the courtesy limit and wait for one second
+        crisis = @client.get_crisis(nil)
+        crisis.class.should eql(NilClass)
+    end
+
+    it "#get_crisis(identifier, { :output => 'short' })" do
+        sleep 1 # Respect the courtesy limit and wait for one second
+        id = "a8763f7e2c432ebe897a68706dcf8dd49243774d"
+        crisis = @client.get_crisis(id, { :output => 'short' })
+        crisis.class.should eql(Hash)
+        crisis['_id'].should eql(id)
+        crisis['subject'].class.should eql(String)
+        crisis['subject'].should eql("flood")
+        crisis['dc_title'].should eql("Green flood alert in Australia")
+    end
+
+end

data/spec/api/client_static_spec.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+require "spec_helper"
+
+describe Sigimera::Client do
+
+	before(:all) do
+        @username = ENV['USERNAME']
+        @password = ENV['PASSWORD']
+	end
+
+    it ".get_auth_token(username, password)" do
+        if @username and @password
+            auth_token = Sigimera::Client.get_auth_token(username = @username, password = @password)
+            auth_token.class.should eql(String)
+            auth_token.should_not be_empty
+        else
+            pending "Please specify ENV['USERNAME'] and ENV['PASSWORD']"
+        end
+    end
+
+    it ".get_api_version" do
+        api_version = Sigimera::Client.get_api_version
+        api_version.class.should eql(String)
+        api_version.should start_with("1.")
+    end
+
+    it ".get_public_crises" do
+        crises = Sigimera::Client.get_public_crises
+        crises.class.should eql(Array)
+        crises.size.should == 10
+        crises.each do |crisis|
+            crisis.class.should eql(Hash)
+            crisis['_id'].class.should eql(String)
+            crisis['_id'].should_not be_empty
+        end
+    end
+
+    it ".get_public_rss_feed" do
+        crises = Sigimera::Client.get_public_rss_feed
+        crises.class.should eql(Nokogiri::XML::Document)
+        crises.xpath("/rss/channel/link/text()").to_s.should eql("http://www.sigimera.org/")
+        crises.xpath("/rss/channel/item").size.should == 10
+    end
+ 
+end

data/spec/api/client_stats_spec.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+require "spec_helper"
+
+describe Sigimera::Client do
+
+	before(:all) do
+		auth_token = ENV['AUTH_TOKEN']
+        if auth_token
+            sleep 1 # Respect the courtesy limit and wait for one second
+            @client = Sigimera::Client.new(auth_token = auth_token)
+        else
+            pending "Plese specify ENV['AUTH_TOKEN']"
+        end
+	end
+
+    it "#get_crises_stat" do
+        crises_stat = @client.get_crises_stat
+        crises_stat['first_crisis_at'].should eql("2012-03-07T00:00:00Z")
+        crises_stat['total_crises'].class.should eql(Fixnum)
+    end
+
+    it "#get_user_stat" do
+        sleep 1 # Respect the courtesy limit and wait for one second
+        user_stat = @client.get_user_stat
+        number_of_calls = user_stat['api_calls']['number_of_calls']
+        number_of_calls.should > 0
+
+        sleep 1 # Respect the courtesy limit and wait for one second
+        second_user_stat = @client.get_user_stat
+        second_user_stat['api_calls']['number_of_calls'].should >= (number_of_calls + 1)
+    end
+
+end

data/spec/spec_helper.rb

@@ -2,7 +2,9 @@ require 'spork'
 
 Spork.prefork do
     require 'simplecov'
-    SimpleCov.start
+    SimpleCov.start do
+        add_filter 'spec'
+    end
 
     RSpec.configure do |config|
         config.mock_with :rspec

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sigimera
 version: !ruby/object:Gem::Version
-  version: 0.0.1.rc2
-  prerelease: 6
+  version: 0.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Alex Oberhauser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-24 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -107,8 +107,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: This is a ruby library that encapsulates access to the Sigimera REST
-  API.
+description: This is the official ruby library for the Sigimera REST API. It encapsulates
+  the authentication process in a secure way and simplifies the access to the Crises
+  Information Platform.
 email:
 - alex.oberhauser@sigimera.org
 executables: []
@@ -128,7 +129,9 @@ files:
 - lib/sigimera/http_helper.rb
 - lib/sigimera/version.rb
 - sigimera.gemspec
-- spec/api/client_spec.rb
+- spec/api/client_crises_spec.rb
+- spec/api/client_static_spec.rb
+- spec/api/client_stats_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Sigimera/sigimera-ruby-client
 licenses:
@@ -145,17 +148,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3216827614524362085
+      hash: -1539845786022213272
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: -1539845786022213272
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: This is a ruby library that encapsulates access to the Sigimera REST API.
+summary: This is the official ruby library for the Sigimera REST API.
 test_files: []

data/spec/api/client_spec.rb

@@ -1,120 +0,0 @@
-require "spec_helper"
-
-describe Sigimera::Client do
-
-	before(:all) do
-		ENV['AUTH_TOKEN'].should_not be_empty
-		@auth_token = ENV['AUTH_TOKEN']
-	end
-
-    it ".get_api_version" do
-        api_version = Sigimera::Client.get_api_version
-        api_version.class.should eql(String)
-        api_version.should start_with("1.")
-    end
-
-    it ".get_public_crises" do
-        crises = Sigimera::Client.get_public_crises
-        crises.class.should eql(Array)
-        crises.size.should == 10
-        crises.each do |crisis|
-            crisis.class.should eql(Hash)
-            crisis['_id'].class.should eql(String)
-            crisis['_id'].should_not be_empty
-        end
-    end
-
-    it ".get_public_rss_feed" do
-        crises = Sigimera::Client.get_public_rss_feed
-        crises.class.should eql(Nokogiri::XML::Document)
-        crises.xpath("/rss/channel/link/text()").to_s.should eql("http://www.sigimera.org/")
-        crises.xpath("/rss/channel/item").size.should == 10
-    end
-
-    it "#get_latest_crises" do
-        client = Sigimera::Client.new(auth_token = @auth_token)
-        crises = client.get_latest_crises
-        crises.class.should eql(Array)
-        crises.size.should == 10
-        crises.each do |crisis|
-            crisis.class.should eql(Hash)
-            crisis['_id'].class.should eql(String)
-            crisis['_id'].should_not be_empty
-        end
-    end
-
-    it "#get_latest_crises(type = 'earthquakes')" do
-        sleep 1 # Respect the courtesy limit and wait for one second
-        client = Sigimera::Client.new(auth_token = @auth_token)
-        crises = client.get_latest_crises(type = "earthquakes")
-        crises.class.should eql(Array)
-        crises.size.should == 10
-        crises.each do |crisis|
-            crisis['dc_subject'].first.should eql("earthquake")
-            crisis.class.should eql(Hash)
-            crisis['_id'].class.should eql(String)
-            crisis['_id'].should_not be_empty
-        end
-    end
-
-    it "#get_latest_crises(type = 'floods')" do
-        sleep 1 # Respect the courtesy limit and wait for one second
-        client = Sigimera::Client.new(auth_token = @auth_token)
-        crises = client.get_latest_crises(type = "floods")
-        crises.class.should eql(Array)
-        crises.size.should == 10
-        crises.each do |crisis|
-            crisis['dc_subject'].first.should eql("flood")
-            crisis.class.should eql(Hash)
-            crisis['_id'].class.should eql(String)
-            crisis['_id'].should_not be_empty
-        end
-    end
-
-    it "#get_latest_crises(type = 'cyclones')" do
-        sleep 1 # Respect the courtesy limit and wait for one second
-        client = Sigimera::Client.new(auth_token = @auth_token)
-        crises = client.get_latest_crises(type = "cyclones")
-        crises.class.should eql(Array)
-        crises.size.should == 10
-        crises.each do |crisis|
-            crisis['dc_subject'].sort.last.should eql("tropical cyclones")
-            crisis.class.should eql(Hash)
-            crisis['_id'].class.should eql(String)
-            crisis['_id'].should_not be_empty
-        end
-    end
-
-    it "#get_latest_crises(type = 'volcanoes')" do
-        sleep 1 # Respect the courtesy limit and wait for one second
-        client = Sigimera::Client.new(auth_token = @auth_token)
-        crises = client.get_latest_crises(type = "volcanoes")
-        crises.class.should eql(Array)
-        crises.size.should > 1
-        crises.each do |crisis|
-            crisis.class.should eql(Hash)
-            crisis['_id'].class.should eql(String)
-            crisis['_id'].should_not be_empty
-        end
-    end
-
-    it "#get_crises_stat" do
-        sleep 1 # Respect the courtesy limit and wait for one second
-        client = Sigimera::Client.new(auth_token = @auth_token)
-        crises_stat = client.get_crises_stat
-        crises_stat['first_crisis_at'].should eql("2012-03-07T00:00:00Z")
-        crises_stat['total_crises'].class.should eql(Fixnum)
-    end
-
-    it "#get_user_stat" do
-        sleep 1 # Respect the courtesy limit and wait for one second
-        client = Sigimera::Client.new(auth_token = @auth_token)
-        user_stat = client.get_user_stat
-        number_of_calls = user_stat['api_calls']['number_of_calls']
-        number_of_calls.should > 0
-
-        sleep 1 # Respect the courtesy limit and wait for one second
-        second_user_stat = client.get_user_stat
-        second_user_stat['api_calls']['number_of_calls'].should == (number_of_calls + 1)
-    end
-end