drone_api 0.1.0

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 drone_api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bryan Fordham
+
+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,61 @@
+# DroneApi
+
+Library to access the DroneApi API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'drone_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install drone_api
+
+## Usage
+
+First, you need a Client
+
+> require 'drone_api'
+> client = DroneApi::Client.new 
+
+You can also call DroneApi.new:
+
+> require 'drone_api'
+> client = DroneApi.new 
+
+If you just want all of the strikes:
+> strikes = client.all
+
+It is an array of Strike instances.
+
+In order to find a specific strike, you can pass in the number.
+
+> strike = client.find 1
+
+This will return a single strike (or nil, if nothing is found). You can also pass in an attribute name and value, and it will return a list containing all strikes matching that parameter.
+
+> x = c.find :bureau_id => 'YEM001' # Returns an array of 1 element
+> six_deaths = c.find :deaths => 6
+
+There are some find_by_X methods. They are based on the attribute names of the Strike class. (If you're familiar with Rails, think model find methods). The following are equale to the examples above:
+
+> x = c.find_by_bureau_id 'YEM001'
+> six_deaths = c.find_by_deaths 6
+
+One think to keep in mind. All these finders return an array *except* find_by_number. This returns a single instance, just as Client.find does.
+
+
+## Contributing
+
+I'm open to all suggestions.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/drone_api.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/drone_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Bryan Fordham"]
+  gem.email         = ["bfordham@gmail.com"]
+  gem.description   = %q{Library to access the DroneApi API}
+  gem.summary       = %q{Allows retrieving drone strike info, and basic searching.}
+  gem.homepage      = "https://github.com/bfordham/drone_api"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "drone_api"
+  gem.require_paths = ["lib"]
+  gem.version       = DroneApi::VERSION
+
+  gem.add_development_dependency 'rspec', '~> 2.13'
+end

data/lib/drone_api/client.rb

@@ -0,0 +1,53 @@
+module DroneApi
+  class Client
+
+    # Returns entire list of strikes
+    #
+    def all
+      @cache ||= Request.get('/data')
+
+    end
+
+    # Locates a specific strike by number
+    def find(params)
+      if params.is_a? Integer
+        find_equals(:number, params)
+      else
+        k,v = params.first
+        find_equals k, v
+      end
+    end
+
+    def method_missing(meth, *args, &block)
+      m = meth.to_s.match(/^find_by_(.+)/)
+      if m
+        key = m[1].to_sym
+        if Strike.new.respond_to? key
+          instance_eval "def #{meth}(val); find_equals :#{key}, val; end"
+          send meth, args.first
+        else
+          super
+        end
+      else
+        super
+      end
+    end
+
+    protected
+
+    def find_equals(key, value)
+      key = key.to_sym
+      value = value.to_s unless value.nil?
+      result = all.select do |s| 
+        test = s.send(key)
+        test = test.to_s unless test.nil?
+        value == test
+      end
+
+      result = result.first if key == :number and not result.nil?
+      return result
+
+    end
+
+  end
+end

data/lib/drone_api/request.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'open-uri'
+
+module DroneApi
+  module Request
+    BASEURL = 'http://api.dronestre.am'
+    def self.get(u)
+      url = "#{BASEURL}/#{u}"
+
+      Strike.parse open(url).read
+    end
+  end
+end

data/lib/drone_api/strike.rb

@@ -0,0 +1,54 @@
+require 'json'
+
+module DroneApi
+  class Strike
+  	attr_reader :id, :number, :country, :date, :town, :location, :deaths, 
+  		:deaths_min, :deaths_max, :civilians, :injuries, :children, :tweet_id, 
+  		:bureau_id, :bij_summary_short, :bij_link, :target, :lat, :lon, 
+  		:articles, :names
+
+  	# Return array of Strike objects from json string
+  	#
+  	def self.parse(js)
+  		data = JSON.parse(js)
+  		strikes = []
+
+  		data['strike'].each	do |s|
+  			strike = Strike.new s
+  			strikes << strike
+  		end unless data['strike'].nil? or data['strike'].empty?
+
+  		return strikes
+  	end
+
+  	# Initialize attributes
+  	#
+  	def initialize(data = nil)
+  		unless data.nil?
+  			data = JSON.parse(data) if data.is_a? String
+
+  			@id = data['_id'] || ''
+			@number = data['number'].to_i || 0
+			@country = data['country'] || ''
+			@date = data['date'] || ''
+			@town = data['town'] || ''
+			@location = data['location'] || ''
+			@deaths = data['deaths'].to_i || 0
+			@deaths_min = data['deaths_min'].to_i || 0
+			@deaths_max = data['deaths_max'].to_i || 0
+			@civilians = data['civilians'].to_i || 0
+			@injuries = data['injuries'].to_i || 0
+			@children = data['children'].to_i || 0
+			@tweet_id = data['tweet_id'] || ''
+			@bureau_id = data['bureau_id'] || ''
+			@summary_short = data['bij_summary_short'] || ''
+			@link = data['bij_link'] || ''
+			@target = data['target'] || ''
+			@lat = data['lat'] || ''
+			@lon = data['lon'] || ''
+			@articles = data['articles'] || ''
+			@names = data['names'] || ''
+  		end
+  	end
+  end
+end

data/lib/drone_api/version.rb

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

data/lib/drone_api.rb

@@ -0,0 +1,19 @@
+require 'drone_api/client'
+require 'drone_api/request'
+require 'drone_api/strike'
+require 'drone_api/version'
+
+module DroneApi
+
+  # Returns a new client
+  #
+  def self.new
+    Client.new
+  end
+
+  # Return the drone_api gem version
+  #
+  def self.version
+    "DroneApi version #{DroneApi::VERSION}"
+  end
+end

data/spec/drone_api_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe 'DroneApi' do
+  it 'should return correct version string' do
+    DroneApi.version.should == "DroneApi version #{DroneApi::VERSION}"
+  end
+end
+
+describe 'DroneApi::Strike' do
+	before do
+		@strike = DroneApi::Strike.new
+	end
+
+	subject { @strike }
+
+	it { should_not respond_to(:some_random_thing) }
+
+	it { should respond_to(:id) }
+	it { should respond_to(:number) }
+	it { should respond_to(:country) }
+	it { should respond_to(:date) }
+	it { should respond_to(:town) }
+	it { should respond_to(:location) }
+	it { should respond_to(:deaths) }
+	it { should respond_to(:deaths_min) }
+	it { should respond_to(:deaths_max) }
+	it { should respond_to(:civilians) }
+	it { should respond_to(:injuries) }
+	it { should respond_to(:children) }
+	it { should respond_to(:tweet_id) }
+	it { should respond_to(:bureau_id) }
+	it { should respond_to(:bij_summary_short) }
+	it { should respond_to(:bij_link) }
+	it { should respond_to(:target) }
+	it { should respond_to(:lat) }
+	it { should respond_to(:lon) }
+	it { should respond_to(:articles) }
+	it { should respond_to(:names) }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$:.unshift File.expand_path("../..", __FILE__)
+
+require 'drone_api'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: drone_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bryan Fordham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: Library to access the DroneApi API
+email:
+- bfordham@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- drone_api.gemspec
+- lib/drone_api.rb
+- lib/drone_api/client.rb
+- lib/drone_api/request.rb
+- lib/drone_api/strike.rb
+- lib/drone_api/version.rb
+- spec/drone_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bfordham/drone_api
+licenses: []
+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.23
+signing_key: 
+specification_version: 3
+summary: Allows retrieving drone strike info, and basic searching.
+test_files:
+- spec/drone_api_spec.rb
+- spec/spec_helper.rb