sigimera 0.0.1 → 0.1.0

data/.gitignore

@@ -16,3 +16,5 @@ tmp
 .yardoc
 _yardoc
 doc/
+
+rspec.xml

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format RspecJunitFormatter
+--out rspec.xml

data/Gemfile.lock

@@ -1,26 +1,31 @@
 PATH
   remote: .
   specs:
-    sigimera (0.0.1)
+    sigimera (0.1.0)
       json
       nokogiri
 
 GEM
   remote: http://rubygems.org/
   specs:
+    builder (3.1.4)
     diff-lcs (1.1.3)
     json (1.7.5)
-    multi_json (1.3.7)
+    multi_json (1.4.0)
     nokogiri (1.5.5)
     rake (10.0.2)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
       rspec-expectations (~> 2.12.0)
       rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.0)
+    rspec-core (2.12.1)
     rspec-expectations (2.12.0)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.12.0)
+    rspec_junit_formatter (0.1.4)
+      builder
+      rspec (~> 2.0)
+      rspec-core (!= 2.12.0)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
@@ -33,6 +38,7 @@ PLATFORMS
 DEPENDENCIES
   rake
   rspec
+  rspec_junit_formatter
   sigimera!
   simplecov
   spork

data/README.md

@@ -3,6 +3,8 @@ Sigimera Client
 
 [![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)
+[![Dependency
+Status](https://gemnasium.com/Sigimera/sigimera-ruby-client.png)](https://gemnasium.com/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

data/Rakefile

@@ -10,7 +10,7 @@ Bundler::GemHelper.install_tasks
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |t|
     t.fail_on_error = true
-    t.rspec_opts = "--colour --format documentation -b"
+    t.rspec_opts = "--colour --format documentation --format RspecJunitFormatter --out rspec.xml"
 end
 
 task :default => :spec

data/bin/sigimera

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+#####
+# Copyright (c) 2012 by Sigimera
+# All rights reserved.
+# See MIT-LICENSE for permissions.
+#####
+require 'rubygems'
+require 'optparse'
+
+begin
+    require 'sigimera'
+rescue LoadError
+    STDERR.puts "Install the missing library:\n\t \e[0;36m$\e[m \e[0;32mgem install sigimera\e[m"
+    exit
+end
+
+begin
+    file = File.join(Dir.home, ".sigimera")
+    Dir.mkdir(File.join(Dir.home, ".sigimera"), 0700) unless File.directory? file
+    credentials = JSON.parse(File.read(File.join(file, "credentials.json")))
+    @auth_token = credentials['auth_token']
+rescue => e
+    STDERR.puts "Please execute:"
+    STDERR.puts "\t$ curl -X POST -u youremail@example.org https://api.sigimera.org/v1/tokens.json > ~/.sigimera/credentials.json"
+    exit 1
+end
+
+
+def make_api_call(options)
+    if @auth_token
+        @client = Sigimera::Client.new @auth_token
+        yield
+    else
+        STDERR.puts "Please execute:"
+        STDERR.puts "\t$ curl -X POST -u youremail@example.org https://api.sigimera.org/v1/tokens.json > ~/.sigimera/credentials.json"
+    end
+end
+
+options = {}
+
+opt_parser = OptionParser.new do |opt|
+    opt.banner = "Usage: sigimera COMMAND [OPTIONS] [ID]"
+    opt.separator  ""
+    opt.separator  "Commands"
+    opt.separator  "     get_latest_crises: retrieves the latest 10 crises"
+    opt.separator  "     get_crisis:        retrieves a single crisis with [ID]"
+    opt.separator  ""
+    opt.separator  "Options"
+
+    opt.on("-h","--help","help") do
+        STDOUT.puts opt_parser
+        exit
+    end
+end
+
+opt_parser.parse!
+
+case ARGV[0]
+when "get_latest_crises"
+    make_api_call(options) do
+        crises = @client.get_latest_crises :output => "short"
+        crises.each do |crisis|
+            STDOUT.puts "--------"
+            STDOUT.puts "ID     :   #{crisis['_id']}"
+            STDOUT.puts "Title  :   #{crisis['dc_title']}"
+            STDOUT.puts "Date   :   #{crisis['dc_date']}"
+            STDOUT.puts ""
+        end
+    end
+when "get_crisis"
+    if ARGV[1]
+        make_api_call(options) do
+            crisis = @client.get_crisis ARGV[1]
+            if crisis
+                STDOUT.puts "============"
+                STDOUT.puts "ID         |   #{crisis['_id']}"
+                STDOUT.puts "Title      |   #{crisis['dc_title']}"
+                STDOUT.puts "Date       |   #{crisis['dc_date']}"
+                STDOUT.puts "Description|   #{crisis['dc_description']}"
+                STDOUT.puts ""
+            else
+                STDOUT.puts "No crisis could be found with the ID '#{ARGV[1]}'"
+            end
+        end
+    else
+        STDERR.puts "Please specify the identifier of the crisis."
+    end
+else
+    STDOUT.puts opt_parser
+end

data/lib/sigimera.rb

@@ -10,10 +10,12 @@ module Sigimera
 	# The Sigimera REST API Host
 	API_HOST 	= "https://api.sigimera.org"
 
-	# The used SSL certificate for the HTTPS encrpytion
+	# The used SSL certificate for the HTTPS connection
 	CACERT_FILE	= File.expand_path("../../certs/cacert.crt", __FILE__)
 end
 
 require "sigimera/version"
 require "sigimera/http_helper"
 require "sigimera/client"
+
+require "sigimera/data/crisis"

data/lib/sigimera/client.rb

@@ -30,7 +30,7 @@ module Sigimera
         def self.get_public_crises
             client = Sigimera::Client.new
             response = client.get("/public/crises.json")
-            JSON.parse response.body if response
+            Client.json_array_to_crisis_array(JSON.parse(response.body)) if response
         end
 
         # This method returns the latest 10 crises as RSS feed,
@@ -66,7 +66,7 @@ module Sigimera
             endpoint = "/v1/crises.json?auth_token=#{@auth_token}"
             endpoint += "&#{URI.encode_www_form params}" if params
             response = self.get(endpoint.to_s)
-            JSON.parse response.body if response and response.body
+            Client.json_array_to_crisis_array(JSON.parse(response.body)) if response and response.body
         end
 
         # This method returns a single crisis.
@@ -78,7 +78,7 @@ module Sigimera
             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 and response.body
+            Sigimera::Crisis.new JSON.parse response.body if response and response.body
         end
 
         # This method returns statistic information about the crises.
@@ -101,5 +101,13 @@ module Sigimera
         # The authentication token that is used for the API calls.
         attr_reader :auth_token
 
+        # Converts a JSON array into an array of #{Crisis} objects
+        def self.json_array_to_crisis_array json_array
+            crises_array = Array.new
+            json_array.each do |crisis|
+                crises_array << Sigimera::Crisis.new(crisis)
+            end
+        end
+
     end
 end

data/lib/sigimera/data/crisis.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+#
+# This library encapsulates the Sigimera REST API access. For more information
+# about the API see http://api.sigimera.org
+#
+# Author::      Alex Oberhauser (mailto:alex.oberhauser@sigimera.org)
+# Copyright::   Copyright (c) 2012 Sigimera
+# License::     MIT
+module Sigimera
+	# This class encapsulates the access to crisis JSON objects. 
+	# Additional it simulates the access syntax of JSON objects.
+	# For future use this class can implemente different type of checks.
+	class Crisis
+
+		def initialize json_object
+			@crisis = json_object
+		end
+
+		# Simulates the same access as for JSON objects
+		def [](key)
+			@crisis[key.to_s] if @crisis and @crisis.class.eql?(Hash)
+		end
+
+		# Provides for each json key an instance method
+		def method_missing(method)
+			@crisis[method.to_s] if @crisis and @crisis.class.eql?(Hash) and @crisis.key?(method.to_s)
+		end
+
+	end
+end

data/lib/sigimera/version.rb

@@ -7,10 +7,10 @@ module Sigimera
         MAJOR = 0
 
         # The minor version number indicates that new features were added.
-        MINOR = 0
+        MINOR = 1
 
         # The tiny number stands for bug fixes.
-        TINY  = 1
+        TINY  = 0
 
         # The extra string marks the version as beta, alpha, rcX, ...
         EXTRA = nil

data/sigimera.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |gem|
     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" ]
+    gem.executables   << "sigimera"
 
     gem.add_runtime_dependency            "json"
     gem.add_runtime_dependency            "nokogiri"  # XML Parsing
@@ -23,4 +24,5 @@ Gem::Specification.new do |gem|
     gem.add_development_dependency "rspec"
     gem.add_development_dependency "spork"
     gem.add_development_dependency "simplecov"
+    gem.add_development_dependency "rspec_junit_formatter"
 end

data/spec/api/client_crises_spec.rb

@@ -96,7 +96,7 @@ describe Sigimera::Client 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.class.should eql(Sigimera::Crisis)
         crisis['_id'].should eql(id)
         crisis['dc_title'].should eql("Green flood alert in Australia")
         crisis['dc_subject'].class.should eql(Array)
@@ -115,7 +115,7 @@ describe Sigimera::Client 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.class.should eql(Sigimera::Crisis)
         crisis['_id'].should eql(id)
         crisis['subject'].class.should eql(String)
         crisis['subject'].should eql("flood")

data/spec/api/client_static_spec.rb

@@ -10,6 +10,7 @@ describe Sigimera::Client do
 
     it ".get_auth_token(username, password)" do
         if @username and @password
+            sleep 1 # Respect the courtesy limit and wait for one second
             auth_token = Sigimera::Client.get_auth_token(username = @username, password = @password)
             auth_token.class.should eql(String)
             auth_token.should_not be_empty
@@ -41,5 +42,5 @@ describe Sigimera::Client do
         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/data/crisis_spec.rb

@@ -0,0 +1,66 @@
+# encoding: UTF-8
+require "spec_helper"
+
+describe Sigimera::Crisis do 
+
+	it "#new crisis_as_json" do
+		json = {
+			"_id" => "1234567890ABCDEFG",
+			"dc_subject" => "cyclone",
+			"test_hash" => {
+				"key1" => "value1",
+				"key2" => "value2"
+			}
+		}
+		crisis = Sigimera::Crisis.new json
+
+		# Access the fields with the help of ruby methods
+		crisis._id.class.should eql(String)
+		crisis._id.should eql("1234567890ABCDEFG")
+
+		crisis.dc_subject.class.should eql(String)
+		crisis.dc_subject.should eql("cyclone")
+
+		test_hash = crisis.test_hash
+		test_hash.class.should eql(Hash)
+		test_hash['key1'].class.should eql(String)
+		test_hash['key1'].should eql("value1")
+		test_hash['key2'].class.should eql(String)
+		test_hash['key2'].should eql("value2")
+
+		crisis.no_method.should eql(nil)
+
+		# Simulate JSON object behavior
+		crisis['_id'].class.should eql(String)
+		crisis['_id'].should eql("1234567890ABCDEFG")
+
+		crisis['dc_subject'].class.should eql(String)
+		crisis['dc_subject'].should eql("cyclone")
+
+		test_hash = crisis['test_hash']
+		test_hash.class.should eql(Hash)
+		test_hash['key1'].class.should eql(String)
+		test_hash['key1'].should eql("value1")
+		test_hash['key2'].class.should eql(String)
+		test_hash['key2'].should eql("value2")
+	end
+
+	it "#new nil" do
+		crisis = Sigimera::Crisis.new nil
+		crisis.no_method.should eql(nil)
+		crisis['no_key'].should eql(nil)
+	end
+
+	it "#new 'some string'" do
+		crisis = Sigimera::Crisis.new "some string"
+		crisis.no_method.should eql(nil)
+		crisis['no_key'].should eql(nil)
+	end
+
+	it "#new 23" do
+		crisis = Sigimera::Crisis.new 23
+		crisis.no_method.should eql(nil)
+		crisis['no_key'].should eql(nil)
+	end
+	
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sigimera
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-28 00:00:00.000000000 Z
+date: 2012-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -107,31 +107,52 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 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: []
+executables:
+- sigimera
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .rvmrc
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
+- bin/sigimera
 - certs/cacert.crt
 - lib/sigimera.rb
 - lib/sigimera/client.rb
+- lib/sigimera/data/crisis.rb
 - lib/sigimera/http_helper.rb
 - lib/sigimera/version.rb
 - sigimera.gemspec
 - spec/api/client_crises_spec.rb
 - spec/api/client_static_spec.rb
 - spec/api/client_stats_spec.rb
+- spec/data/crisis_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Sigimera/sigimera-ruby-client
 licenses:
@@ -148,7 +169,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1539845786022213272
+      hash: 336144546145436383
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -157,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1539845786022213272
+      hash: 336144546145436383
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24