crp 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 384fb08ad5f37298a1f005bfa74cd691240ddd34
-  data.tar.gz: 975e4cc203e8ab982c66bff6fd9351ba4f848d3a
+  metadata.gz: 0259d44e42bd8fc86a0d99612041c1b9b2b760a8
+  data.tar.gz: 1218348d94e41efc33990fe40af55bbab64c820b
 SHA512:
-  metadata.gz: 821ffa6c8e96aa6516201ba1c72b8991208fec87dfa704f98581eb7875f901b090b3d6099733223fb526e3505bf7682aa94cb05c731fbd97d3fb4c880df3cadb
-  data.tar.gz: b8ba5b6eb1aea5cdc12b259951472063f5e3b859b006b42af33b2c7c91ae31a7ead5d51486525749e0be4cc4fa4480239fa20041a5e2aacd8d9795025d54438e
+  metadata.gz: c1c330c3b805c2723d508c3f74c964d0f6324eb077122c94ecc4f64a741493911d984caa2267969740ddc7887a7cad8a10d287a4fe6b06802827505567f3b41c
+  data.tar.gz: 573dff2c07ebcf0193bcc7624ae9fac7773205be8e2c0fe121b04de3630ed8dc679a9d719ab25363b97fb57c82bf2c3c44711b273da9d2faa2a5635e915d86a8

data/README.md

@@ -4,7 +4,7 @@ The **C**entral **R**eview **P**latform is a platform to review user uploaded da
 
 ## Installation
 
-The CRP gem is Ruby 1.9.x and 2.0.x compatible.
+The CRP gem is Ruby 1.9.x and 2.0.x compatible and hosted on [RubyGems](https://rubygems.org/gems/crp).
 
 Add this line to your application's Gemfile:
 
@@ -27,14 +27,14 @@ require "crp"
  => true
 review_poster = CRP::ReviewPoster.new("crp.example.com", "client", "key")
  => #<CRP::ReviewPoster:0x007fa2c1119110 @host="crp.example.com", @client="client", @key="key">
-review_response = review_poster.new_review(1, "davy22", 123, 2, "davy22", 55)
+review_response = review_poster.new_review(1, "davy22", "123ABC", :female, "davy22", 55)
  => #<CRP::ReviewResponse:0x007fa87c1fd020 @response=#<Net::HTTPOK 200 OK readbody=true>>
 review_response.successful?
  => true
 review_response.internal_id
- => 123
+ => "123ABC"
 review_response.external_id
- => "4321"
+ => "ABCD1234"
 ````
 
 You can skip the host, client and key parameters and specify the `ENV['CRP_HOST']`, `ENV['CRP_CLIENT']` and `ENV['CRP_KEY']` environment variable for convenience.

data/lib/crp/gender_mapper.rb

@@ -0,0 +1,19 @@
+require 'cgi'
+
+module CRP
+  GENDER_NAME_CODES = { 1 => :female, 2 => :male }
+
+  class GenderMapper
+    # Maps the +:unknown+, +:female+ or +:male+ gender names to their respective CRP
+    # gender codes. Invalid gender names will reeturn the unknown gender code of +0+.
+    def self.to_code(name)
+      GENDER_NAME_CODES.invert[name] || 0
+    end
+
+    # Maps the CRP gender codes to the more friendly +:unknown+, +:female+ or +:male+ gender
+    # names. Invalid codes wil return an +:unknown+ gender name.
+    def self.to_name(code)
+      GENDER_NAME_CODES[code] || :unknown
+    end
+  end
+end

data/lib/crp/result_mapper.rb

@@ -2,6 +2,7 @@ require 'cgi'
 
 module CRP
   class ResultMapper
+    # Maps the CRP result codes to a human readable message.
     def self.to_message(code)
       case code
       when 1

data/lib/crp/review_poster.rb

@@ -16,6 +16,7 @@ module CRP
       @key    = key
     end
 
+    # Submits a new profile review to CRP.
     def new_review(review_type, review_content, internal_review_id, gender, username, age)
       uri              = new_review_url(review_type, review_content, internal_review_id, gender, username, age)
       http             = Net::HTTP.new(uri.host, uri.port)
@@ -26,12 +27,13 @@ module CRP
       ReviewResponse.new(response)
     end
 
+    # Builds a new URL needed to submit a profile review to CRP.
     def new_review_url(review_type, review_content, internal_review_id, gender, username, age)
       arguments = [{
                     reviewType:       review_type,
                     reviewContent:    review_content,
                     internalReviewId: internal_review_id,
-                    gender:           gender,
+                    gender:           GenderMapper.to_code(gender),
                     username:         username,
                     age:              age
                   }].to_json

data/lib/crp/review_response.rb

@@ -19,7 +19,7 @@ module CRP
     end
 
     def internal_id
-      raw_review.first["internalId"]
+      raw_review.first["internalId"].to_s
     end
 
     def external_id

data/lib/crp/version.rb

@@ -1,3 +1,3 @@
 module CRP
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/crp.rb

@@ -3,6 +3,7 @@ require "crp/review_poster"
 require "crp/review_response"
 require "crp/review_callback_response"
 require "crp/result_mapper"
+require "crp/gender_mapper"
 
 module CRP
 end

data/test/fixtures/valid_review.json

@@ -1,6 +1,6 @@
 [
   {
-    "internalId": 123,
-    "externalId": "4321"
+    "internalId": "ABC123",
+    "externalId": "321BCA"
   }
 ]

data/test/fixtures/valid_review_with_integer_internal_id.json

@@ -0,0 +1,6 @@
+[
+  {
+    "internalId": 1234,
+    "externalId": "321BCA"
+  }
+]

data/test/gender_mapper_test.rb

@@ -0,0 +1,59 @@
+require File.expand_path("#{File.dirname(__FILE__)}/test_helper")
+
+require 'cgi'
+
+module CRP
+  describe GenderMapper do
+    describe :to_code do
+      describe "when the gender is unknown" do
+        it "returns code 0" do
+          GenderMapper.to_code(:unknown).must_equal(0)
+        end
+      end
+
+      describe "when the gender is female" do
+        it "returns code 1" do
+          GenderMapper.to_code(:female).must_equal(1)
+        end
+      end
+
+      describe "when the gender is male" do
+        it "returns code 2" do
+          GenderMapper.to_code(:male).must_equal(2)
+        end
+      end
+
+      describe "when the gender is not :unknown, :female or :male" do
+        it "returns code 0" do
+          GenderMapper.to_code(:alien).must_equal(0)
+        end
+      end
+    end
+
+    describe :to_name do
+      describe "when the code is 0" do
+        it "returns unknown as gender" do
+          GenderMapper.to_name(0).must_equal(:unknown)
+        end
+      end
+
+      describe "when the code is 1" do
+        it "returns female as gender" do
+          GenderMapper.to_name(1).must_equal(:female)
+        end
+      end
+
+      describe "when the code is 2" do
+        it "returns male as gender" do
+          GenderMapper.to_name(2).must_equal(:male)
+        end
+      end
+
+      describe "when the code is not 0, 1 or 2" do
+        it "returns :unknown as gender" do
+          GenderMapper.to_name(99).must_equal(:unknown)
+        end
+      end
+    end
+  end
+end

data/test/review_poster_test.rb

@@ -8,7 +8,7 @@ module CRP
     REVIEW_TYPE        = 1
     REVIEW_CONTENT     = "I am a very cheerful and good-humored."
     INTERNAL_REVIEW_ID = "ABCDE12345"
-    GENDER             = 1
+    GENDER             = :female
     USERNAME           = "starryheart28"
     AGE                = 28
 

data/test/review_response_test.rb

@@ -56,15 +56,33 @@ module CRP
     end
 
     describe :internal_id do
-      before do
-        @response = MiniTest::Mock.new # can't set response.body for some reason
-        @response.expect(:code, "200")
-        @response.expect(:body, valid_review_body)
+      describe "when the internal id is a string" do
+        before do
+          @response = MiniTest::Mock.new # can't set response.body for some reason
+          @response.expect(:code, "200")
+          @response.expect(:body, valid_review_body)
+        end
+
+        it "returns the internal id from the response string" do
+          review_response = ReviewResponse.new(@response)
+          review_response.internal_id.must_equal("ABC123")
+        end
       end
 
-      it "returns the internal id from the response" do
-        review_response = ReviewResponse.new(@response)
-        review_response.internal_id.must_equal(123)
+      describe "when the internal id is an integer" do
+        before do
+          @response = MiniTest::Mock.new # can't set response.body for some reason
+          @response.expect(:code, "200")
+          @response.expect(:body, valid_review_body_with_integer_internal_id)
+        end
+
+        it "returns the internal id from the response as a string" do
+          # The first CRP response keeps the type you sent it but all subsequent reviews
+          # will return the intenal id as a string so abstract this away by always
+          # returning a string from the gem
+          review_response = ReviewResponse.new(@response)
+          review_response.internal_id.must_equal("1234")
+        end
       end
     end
 
@@ -77,7 +95,7 @@ module CRP
 
       it "returns the external id from the response" do
         review_response = ReviewResponse.new(@response)
-        review_response.external_id.must_equal("4321")
+        review_response.external_id.must_equal("321BCA")
       end
     end
   end

data/test/test_helper.rb

@@ -10,6 +10,10 @@ def valid_review_body
   @valid_review_body ||= File.read(File.join(FIXTURES_PATH, 'valid_review.json'))
 end
 
+def valid_review_body_with_integer_internal_id
+  @valid_review_body_with_integer_internal_id ||= File.read(File.join(FIXTURES_PATH, 'valid_review_with_integer_internal_id.json'))
+end
+
 def valid_callback_review_body
   @valid_callback_review_body ||= File.read(File.join(FIXTURES_PATH, 'valid_callback_review.txt')).chomp
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Agile Wings
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-14 00:00:00.000000000 Z
+date: 2013-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
@@ -52,6 +52,7 @@ files:
 - Rakefile
 - crp.gemspec
 - lib/crp.rb
+- lib/crp/gender_mapper.rb
 - lib/crp/result_mapper.rb
 - lib/crp/review_callback_response.rb
 - lib/crp/review_poster.rb
@@ -59,6 +60,8 @@ files:
 - lib/crp/version.rb
 - test/fixtures/valid_callback_review.txt
 - test/fixtures/valid_review.json
+- test/fixtures/valid_review_with_integer_internal_id.json
+- test/gender_mapper_test.rb
 - test/result_mapper_test.rb
 - test/review_callback_response_test.rb
 - test/review_poster_test.rb
@@ -92,6 +95,8 @@ summary: The Central Review Platform is a platform to review user uploaded data.
 test_files:
 - test/fixtures/valid_callback_review.txt
 - test/fixtures/valid_review.json
+- test/fixtures/valid_review_with_integer_internal_id.json
+- test/gender_mapper_test.rb
 - test/result_mapper_test.rb
 - test/review_callback_response_test.rb
 - test/review_poster_test.rb