iraq_unrest 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +18 -0
  3. data/Gemfile +4 -0
  4. data/LICENSE.txt +22 -0
  5. data/README.md +114 -0
  6. data/Rakefile +7 -0
  7. data/examples/example_01.png +0 -0
  8. data/examples/example_02.png +0 -0
  9. data/examples/example_03.png +0 -0
  10. data/examples/iraq_government_casualty_figure.csv +95 -0
  11. data/examples/iraq_government_casualty_figure.html +126 -0
  12. data/examples/iraqi_casualties_comparison.csv +119 -0
  13. data/examples/iraqi_casualties_comparison.html +105 -0
  14. data/iraq_unrest.gemspec +33 -0
  15. data/lib/iraq_unrest/concerns/serializable.rb +37 -0
  16. data/lib/iraq_unrest/concerns/validatable.rb +18 -0
  17. data/lib/iraq_unrest/config.rb +8 -0
  18. data/lib/iraq_unrest/data/Iraq_Government_Casualty_Figure.csv +116 -0
  19. data/lib/iraq_unrest/data_set.rb +41 -0
  20. data/lib/iraq_unrest/erb/header.html.erb +32 -0
  21. data/lib/iraq_unrest/erb/iraq_government_casualty_figure.html.erb +94 -0
  22. data/lib/iraq_unrest/erb/iraqi_casualties_comparison.html.erb +73 -0
  23. data/lib/iraq_unrest/format.rb +103 -0
  24. data/lib/iraq_unrest/google_doc.rb +31 -0
  25. data/lib/iraq_unrest/iraq_government_casualty_figure.rb +53 -0
  26. data/lib/iraq_unrest/iraq_unrest_record.rb +74 -0
  27. data/lib/iraq_unrest/iraqi_casualties_comparison.rb +46 -0
  28. data/lib/iraq_unrest/serializers.rb +46 -0
  29. data/lib/iraq_unrest/version.rb +3 -0
  30. data/lib/iraq_unrest.rb +50 -0
  31. data/test/fixtures/vcr_cassettes/iraq_government_casualty_figure.yml +161 -0
  32. data/test/fixtures/vcr_cassettes/iraqi_casualties_comparison.yml +184 -0
  33. data/test/google_doc_test.rb +56 -0
  34. data/test/iraq_government_casualty_figure_test.rb +253 -0
  35. data/test/iraqi_casualties_comparison_test.rb +246 -0
  36. data/test/test_helper.rb +17 -0
  37. data/test/validatable_test.rb +34 -0
  38. metadata +242 -0
@@ -0,0 +1,246 @@
1
+ require 'test_helper'
2
+
3
+ module IraqUnrest
4
+
5
+ describe IraqiCasualtiesComparison do
6
+
7
+ before { VCR.insert_cassette 'iraqi_casualties_comparison', :re_record_interval => 86400 }
8
+ after { VCR.eject_cassette }
9
+
10
+ describe "an instance" do
11
+
12
+ before { @object = IraqiCasualtiesComparison.new(:date => "Sep-2013") }
13
+
14
+ describe "when asked as_json" do
15
+ it "must be a Hash" do
16
+ @object.as_json.must_be_instance_of Hash
17
+ end
18
+ end
19
+
20
+ describe "when asked to_json" do
21
+ it "must be a String" do
22
+ @object.to_json.must_be_instance_of String
23
+ end
24
+ end
25
+
26
+ end
27
+
28
+ describe "the data set" do
29
+
30
+ it "must return 609 when asked for the number of casualties reported in Jan-2004 by the Iraq Body Count" do
31
+ IraqiCasualtiesComparison.all.find {|item| item.date == "Jan-2004" }.iraq_body_count.must_equal "609"
32
+ end
33
+
34
+ it "must return 618 when asked for the number of casualties reported in Aug-2009 by the Iraq Body Count" do
35
+ IraqiCasualtiesComparison.all.find {|item| item.date == "Aug-2009" }.iraq_body_count.must_equal "618"
36
+ end
37
+
38
+ it "must return 1850 when asked for the number of casualties reported in Jul-2006 by the Iraq Government" do
39
+ IraqiCasualtiesComparison.all.find {|item| item.date == "Jul-2006" }.iraq_gov.must_equal "1850"
40
+ end
41
+
42
+ it "must return 205 when asked for the number of casualties reported in Apr-2013 by the Iraq Government" do
43
+ IraqiCasualtiesComparison.all.find {|item| item.date == "Apr-2013" }.iraq_gov.must_equal "205"
44
+ end
45
+
46
+ it "must return 253 when asked for the number of casualties reported in Sep-2012 by the AFP" do
47
+ IraqiCasualtiesComparison.all.find {|item| item.date == "Sep-2012" }.afp.must_equal "253"
48
+ end
49
+
50
+ it "must return 220 when asked for the number of casualties reported in Feb-2013 by the AFP" do
51
+ IraqiCasualtiesComparison.all.find {|item| item.date == "Feb-2013" }.afp.must_equal "220"
52
+ end
53
+
54
+ end
55
+
56
+ describe "class methods" do
57
+
58
+ describe "when asked for a raw csv" do
59
+ it "must return a String" do
60
+ IraqiCasualtiesComparison.raw_csv.must_be_kind_of String
61
+ end
62
+ end
63
+
64
+ describe "when asked for a CSV" do
65
+
66
+ before { @csv = IraqiCasualtiesComparison.to_csv }
67
+
68
+ it "must return a String" do
69
+ @csv.must_be_kind_of String
70
+ end
71
+
72
+ describe "Parsring the String into a CSV object" do
73
+
74
+ before do
75
+ @csv_object = CSV.parse(@csv, :headers => true,
76
+ :header_converters => :symbol)
77
+ end
78
+
79
+ it "must have the correct headers" do
80
+ @csv_object.headers.must_equal IraqiCasualtiesComparison::ATTRIBUTES
81
+ end
82
+
83
+ it "must have a dates in the format of mmm-YYYY in the first colum" do
84
+ @csv_object.values_at(:date).flatten.map {|date| Date::strptime(date,"%b-%Y") }
85
+ end
86
+
87
+ it "must have at least 100 rows" do
88
+ @csv_object.size.must_be :>=, 100
89
+ end
90
+
91
+ end
92
+
93
+ end
94
+
95
+ describe "when asked to generate a CSV" do
96
+
97
+ before { @file = IraqiCasualtiesComparison.to_csv! }
98
+
99
+ it "must return a File object" do
100
+ @file.must_be_kind_of File
101
+ end
102
+
103
+ it "must create a file" do
104
+ @file.path.must_equal IraqiCasualtiesComparison.file_name + ".csv"
105
+ (File.exists? @file.path).must_equal true
106
+ end
107
+
108
+ describe "CSV file" do
109
+
110
+ before do
111
+ @csv = CSV.table(@file.path, :skip_lines => /#/)
112
+ end
113
+
114
+ it "must have the correct headers" do
115
+ @csv.headers.must_equal IraqiCasualtiesComparison::ATTRIBUTES
116
+ end
117
+
118
+ it "wont be empty" do
119
+ @csv.empty?.must_equal false
120
+ end
121
+
122
+ end
123
+
124
+ end
125
+
126
+ describe "when asked as_json#to_json" do
127
+
128
+ before do
129
+ @json = IraqUnrest::IraqiCasualtiesComparison.as_json.to_json
130
+ end
131
+
132
+ it "must return a JSON string of all objects" do
133
+ @json.wont_be_nil
134
+ @json.must_be_kind_of String
135
+ @parsed = JSON.parse(@json)
136
+ @parsed.must_be_kind_of Array
137
+ @parsed.first.empty?.must_equal false
138
+ end
139
+
140
+ end
141
+
142
+ describe "when asked as_json" do
143
+
144
+ before do
145
+ @json = IraqUnrest::IraqiCasualtiesComparison.as_json
146
+ end
147
+
148
+ it "must return an Array" do
149
+ @json.wont_be_nil
150
+ @json.must_be_kind_of Array
151
+ @generated = JSON.generate(@json)
152
+ @generated.must_be_kind_of String
153
+ end
154
+
155
+ end
156
+
157
+ describe "when asked to generate a rickshaw data structure" do
158
+ before do
159
+ @data = IraqiCasualtiesComparison.as_rickshaw
160
+ @attr = [:afp, :iraq_gov, :iraq_body_count]
161
+ end
162
+
163
+ it "must have keys [:afp, :iraq_gov, :iraq_body_count] and not include a date" do
164
+ @data.keys.must_equal @attr
165
+ end
166
+
167
+ it "must contain formatted array of hashes for each attribute" do
168
+ @attr.each do |attr|
169
+ @data[attr].each do |data_point|
170
+ data_point.keys.must_equal [:x, :y]
171
+ Date.strptime(data_point[:x].to_s, "%s").must_be_instance_of Date
172
+ end
173
+ end
174
+ end
175
+
176
+ end
177
+
178
+ describe "when asked for HTML" do
179
+
180
+ before do
181
+ @html = IraqiCasualtiesComparison.to_html
182
+ end
183
+
184
+ it "must return a String" do
185
+ @html.must_be_kind_of String
186
+ end
187
+
188
+ end
189
+
190
+ describe "when asked to generate HTML" do
191
+
192
+ before { @file = IraqiCasualtiesComparison.to_html! }
193
+
194
+ it "must return a File object" do
195
+ @file.must_be_kind_of File
196
+ end
197
+
198
+ it "must create a file" do
199
+ @file.path.must_equal IraqiCasualtiesComparison.file_name + ".html"
200
+ (File.exists? @file.path).must_equal true
201
+ end
202
+
203
+ end
204
+
205
+ describe "when asked to visualize all records" do
206
+
207
+ before { @file = IraqiCasualtiesComparison.visualize! }
208
+
209
+ it "must return a File object" do
210
+ @file.must_be_kind_of File
211
+ end
212
+
213
+ it "must create a file" do
214
+ @file.path.must_equal IraqiCasualtiesComparison.file_name + ".html"
215
+ (File.exists? @file.path).must_equal true
216
+ end
217
+
218
+ end
219
+
220
+ describe "when asked for all records" do
221
+ it "must return a collection of IraqiCasualtiesComparison objects" do
222
+ data = IraqiCasualtiesComparison.all
223
+ data.must_be_kind_of Enumerable
224
+ data.size.must_be :>, 100
225
+ data.first.must_be_kind_of IraqiCasualtiesComparison
226
+ end
227
+ end
228
+
229
+ describe "when asked for a file name" do
230
+ it "must respond with a properly formatted file name" do
231
+ IraqiCasualtiesComparison.file_name.must_equal 'iraqi_casualties_comparison'
232
+ end
233
+ end
234
+
235
+ describe "when asked to parse raw data" do
236
+ it "must raise an Exception if it cannot find a title" do
237
+ err = proc {IraqiCasualtiesComparison.parse("Foo,Bar,Baz,\n")}.must_raise Exception
238
+ err.message.must_match /^Could not find a valid title in data source$/
239
+ end
240
+ end
241
+
242
+ end
243
+
244
+ end
245
+
246
+ end
@@ -0,0 +1,17 @@
1
+ require 'iraq_unrest' # Require our gem so we can test it
2
+ require 'byebug'
3
+ require 'ap'
4
+
5
+ require 'webmock/minitest'
6
+ WebMock.allow_net_connect! # Test against the live data source
7
+
8
+ require 'vcr'
9
+ VCR.configure do |c|
10
+ c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
11
+ c.hook_into :webmock
12
+ end
13
+
14
+ require 'minitest/spec'
15
+ require 'minitest/unit'
16
+ require 'minitest/pride'
17
+ require 'minitest/autorun' # Actually runs the tests
@@ -0,0 +1,34 @@
1
+ require 'test_helper'
2
+
3
+ module IraqUnrest
4
+
5
+ class DummyClass < IraqUnrest::DataSet; attr_accessor :date end
6
+
7
+ describe Validatable do
8
+
9
+ before { @object = DummyClass.new(:date => "Sep-2013") }
10
+
11
+ it "wont recognize this month as valid" do
12
+ @object.date = Date.current.strftime("%b-%Y")
13
+ @object.wont_be(:valid?)
14
+ end
15
+
16
+ it "wont recognize next month as valid" do
17
+ next_month = Date.current.next_month.strftime("%b-%Y")
18
+ @object.date = next_month
19
+ @object.wont_be(:valid?)
20
+ end
21
+
22
+ it "must recognize Sep-2013 as a valid date" do
23
+ @object.date = "Sep-2013"
24
+ @object.must_be(:valid?)
25
+ end
26
+
27
+ it "wont recognize 01/01/1970 as a valid date" do
28
+ @object.date = "01/01/1970"
29
+ @object.wont_be(:valid?)
30
+ end
31
+
32
+ end
33
+
34
+ end
metadata ADDED
@@ -0,0 +1,242 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: iraq_unrest
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Brian D. Smith
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2013-11-12 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: curb
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - '>='
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - '>='
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: tilt
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: active_model_serializers
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: activesupport
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - '>='
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: bundler
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ~>
74
+ - !ruby/object:Gem::Version
75
+ version: '1.3'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ~>
81
+ - !ruby/object:Gem::Version
82
+ version: '1.3'
83
+ - !ruby/object:Gem::Dependency
84
+ name: webmock
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - <
88
+ - !ruby/object:Gem::Version
89
+ version: '1.14'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - <
95
+ - !ruby/object:Gem::Version
96
+ version: '1.14'
97
+ - !ruby/object:Gem::Dependency
98
+ name: vcr
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - '>='
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - '>='
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: minitest
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - '>='
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - '>='
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: rake
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - '>='
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - '>='
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: awesome_print
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - '>='
144
+ - !ruby/object:Gem::Version
145
+ version: '0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - '>='
151
+ - !ruby/object:Gem::Version
152
+ version: '0'
153
+ - !ruby/object:Gem::Dependency
154
+ name: byebug
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - '>='
158
+ - !ruby/object:Gem::Version
159
+ version: '0'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - '>='
165
+ - !ruby/object:Gem::Version
166
+ version: '0'
167
+ description: Ruby library to serialize, format, and visualize Iraq data shared by
168
+ Agence France-Presse.
169
+ email:
170
+ - bd9302@gmail.com
171
+ executables: []
172
+ extensions: []
173
+ extra_rdoc_files: []
174
+ files:
175
+ - .gitignore
176
+ - Gemfile
177
+ - LICENSE.txt
178
+ - README.md
179
+ - Rakefile
180
+ - examples/example_01.png
181
+ - examples/example_02.png
182
+ - examples/example_03.png
183
+ - examples/iraq_government_casualty_figure.csv
184
+ - examples/iraq_government_casualty_figure.html
185
+ - examples/iraqi_casualties_comparison.csv
186
+ - examples/iraqi_casualties_comparison.html
187
+ - iraq_unrest.gemspec
188
+ - lib/iraq_unrest.rb
189
+ - lib/iraq_unrest/concerns/serializable.rb
190
+ - lib/iraq_unrest/concerns/validatable.rb
191
+ - lib/iraq_unrest/config.rb
192
+ - lib/iraq_unrest/data/Iraq_Government_Casualty_Figure.csv
193
+ - lib/iraq_unrest/data_set.rb
194
+ - lib/iraq_unrest/erb/header.html.erb
195
+ - lib/iraq_unrest/erb/iraq_government_casualty_figure.html.erb
196
+ - lib/iraq_unrest/erb/iraqi_casualties_comparison.html.erb
197
+ - lib/iraq_unrest/format.rb
198
+ - lib/iraq_unrest/google_doc.rb
199
+ - lib/iraq_unrest/iraq_government_casualty_figure.rb
200
+ - lib/iraq_unrest/iraq_unrest_record.rb
201
+ - lib/iraq_unrest/iraqi_casualties_comparison.rb
202
+ - lib/iraq_unrest/serializers.rb
203
+ - lib/iraq_unrest/version.rb
204
+ - test/fixtures/vcr_cassettes/iraq_government_casualty_figure.yml
205
+ - test/fixtures/vcr_cassettes/iraqi_casualties_comparison.yml
206
+ - test/google_doc_test.rb
207
+ - test/iraq_government_casualty_figure_test.rb
208
+ - test/iraqi_casualties_comparison_test.rb
209
+ - test/test_helper.rb
210
+ - test/validatable_test.rb
211
+ homepage: https://github.com/bds/iraq_unrest
212
+ licenses:
213
+ - MIT
214
+ metadata: {}
215
+ post_install_message:
216
+ rdoc_options: []
217
+ require_paths:
218
+ - lib
219
+ required_ruby_version: !ruby/object:Gem::Requirement
220
+ requirements:
221
+ - - '>='
222
+ - !ruby/object:Gem::Version
223
+ version: '0'
224
+ required_rubygems_version: !ruby/object:Gem::Requirement
225
+ requirements:
226
+ - - '>='
227
+ - !ruby/object:Gem::Version
228
+ version: '0'
229
+ requirements: []
230
+ rubyforge_project:
231
+ rubygems_version: 2.0.3
232
+ signing_key:
233
+ specification_version: 4
234
+ summary: Generates Rickshaw/D3.js graphs and formatted data files for Iraq data
235
+ test_files:
236
+ - test/fixtures/vcr_cassettes/iraq_government_casualty_figure.yml
237
+ - test/fixtures/vcr_cassettes/iraqi_casualties_comparison.yml
238
+ - test/google_doc_test.rb
239
+ - test/iraq_government_casualty_figure_test.rb
240
+ - test/iraqi_casualties_comparison_test.rb
241
+ - test/test_helper.rb
242
+ - test/validatable_test.rb