paper-cup 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c341398114a2a9df8db16fdabaafaeddc12112c
-  data.tar.gz: faf80ab69ab9ab93de024834cd141791c6332b06
+  metadata.gz: 2fe587af3f94b03560c48e7230b74463eeb6b8f5
+  data.tar.gz: a58fa340c4a8c565964e7a33d7f646b6a03711d5
 SHA512:
-  metadata.gz: d438c4b0506ccd7bb9da19cb1f8a02f533ac3b82fd278d0a37afde50cfbad6fbfb72e2a510bb07cf13665bc890cc4331585830aeeba48418d40af6d58c90d544
-  data.tar.gz: 817983209a7a5605beba459718e75b225c6d2b65a911f381dd46cade61bc9f357632f3cdd78f6c71a028a0bf9916dbec7e1c2e41d3ae29de3f5d7f3bd7771702
+  metadata.gz: 89d19d3bef95afa1467681a6cdf7ddb732fd58817e51b71dd6d684af9a3361fc686a6673c39b52295c7f4c57da48108dc55076c929bc4c8a660dbbfda21ac150
+  data.tar.gz: c8e58104bcae79dff315f1c9e76bb95e5ecf4ed0a9696446b7b66fb56248cff22d5e6af31397d3bc07e80c34b1a510a5144d958c3e434dede1407039a7a6d287

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+0.2.1 / August 5, 2015
+==================
+
+* Start usign [Recursive Open Struct] for the response.
+
+0.2.0 / August 5, 2015
+==================
+
+* Added Client.
+
+0.1.0 / August 5, 2015
+==================
+
+* Initial release.
+
+[Recursive Open Struct]: <https://github.com/aetherknight/recursive-open-struct>

data/README.md

@@ -44,12 +44,12 @@ users = client.endpoint(:users)
 
 response = users.get(:casapick)
 response.body
-=> {"login"=>"casapick",
- "id"=>8136680,
- "avatar_url"=>"https://avatars.githubusercontent.com/u/8136680?v=3",
+=> #<RecursiveOpenStruct login="casapick",
+  id=8136680,
+  avatar_url="https://avatars.githubusercontent.com/u/8136680?v=3",
  # ...
- "created_at"=>"2014-07-11T15:41:22Z",
- "updated_at"=>"2015-07-29T18:39:00Z"}
+  created_at="2014-07-11T15:41:22Z",
+  updated_at="2015-07-29T18:39:00Z">
 ~~~
 
 GET

data/lib/paper_cup/response.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'recursive_open_struct'
 require_relative 'utils'
 
 module PaperCup
@@ -12,7 +13,7 @@ module PaperCup
     def body
       @body ||= begin
         str = @raw_response[0..-4]
-        PaperCup.valid_json?(str) ? JSON.parse(str) : str
+        PaperCup.valid_json?(str) ? build_body(JSON.parse(str)) : str
       end
     end
 
@@ -23,5 +24,15 @@ module PaperCup
     def success?
       status.between?(200, 299)
     end
+
+    private
+
+    def build_body(str)
+      if str.class == Array
+        str.map { |e| RecursiveOpenStruct.new(e, recurse_over_arrays: true) }
+      else
+        RecursiveOpenStruct.new(str, recurse_over_arrays: true)
+      end
+    end
   end
 end

data/paper-cup.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'paper-cup'
-  s.version     = '0.2.0'
+  s.version     = '0.2.1'
   s.date        = '2015-08-05'
   s.summary     = "Use of Open3 to make request"
   s.description = "Use curl with Open3 for making request"
@@ -16,4 +16,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "minitest-happy", '~> 1.0.0'
   s.add_development_dependency "pry", '~> 0.10.1'
   s.add_development_dependency "rake", '~> 10.4.2'
+  s.add_development_dependency "recursive-open-struct", '~> 0.6.5'
 end

data/test/paper_cup_test.rb

@@ -5,7 +5,7 @@ describe PaperCup do
   describe "when doing a GET request to an url" do
     describe "that respond with a JSON" do
       it "must parse the response" do
-        Open3.stub :capture3, [Mock.json] do   # stub goes away once the block is done
+        Open3.stub :capture3, [Mock.json_array] do   # stub goes away once the block is done
           r = PaperCup.get("http://www.google.com")
           assert_equal "Rails", r.body.first["framework"], "The framework must be rails"
         end

data/test/paper_cup_test/client_test.rb

@@ -4,7 +4,7 @@ def client
   @client ||= PaperCup::Client.new(
     url:     'http://api.github.com',
     params:  { test_param_1: :pepito, test_param_2: :pepita },
-    headers: { 'X-Test-Header-1': :pepote, 'X-Test-Header-2': :papita }
+    headers: { 'X-Test-Header-1' => :pepote, 'X-Test-Header-2' => :papita }
   )
 end
 
@@ -14,23 +14,23 @@ describe PaperCup::Client do
       method:   :get,
       path:     '/users/casapick',
       params:   { test_param_2: :popote, test_param_3: :papota },
-      headers:  { 'X-Test-Header-2': :popote, 'X-Test-Header-3': :papota }
+      headers:  { 'X-Test-Header-2' => :popote, 'X-Test-Header-3' => :papota }
     }
 
     assert_equal result.fetch(:method), :get
     assert_equal result.fetch(:url), 'http://api.github.com/users/casapick'
     assert_equal result.fetch(:params), test_param_1: :pepito, test_param_2: :popote, test_param_3: :papota
-    assert_equal result.fetch(:headers), 'X-Test-Header-1': :pepote, 'X-Test-Header-2': :popote, 'X-Test-Header-3': :papota
+    assert_equal result.fetch(:headers), 'X-Test-Header-1' => :pepote, 'X-Test-Header-2' => :popote, 'X-Test-Header-3' => :papota
   end
 
   it '#endpoint returns a new client with merged url, params and headers' do
     users = client.endpoint(:users,
       params:   { test_param_2: :popote, test_param_3: :papota },
-      headers:  { 'X-Test-Header-2': :popote, 'X-Test-Header-3': :papota }
+      headers:  { 'X-Test-Header-2' => :popote, 'X-Test-Header-3' => :papota }
     )
 
     assert_equal users.url, 'http://api.github.com/users'
     assert_equal users.params, test_param_1: :pepito, test_param_2: :popote, test_param_3: :papota
-    assert_equal users.headers, 'X-Test-Header-1': :pepote, 'X-Test-Header-2': :popote, 'X-Test-Header-3': :papota
+    assert_equal users.headers, 'X-Test-Header-1' => :pepote, 'X-Test-Header-2' => :popote, 'X-Test-Header-3' => :papota
   end
 end

data/test/paper_cup_test/response_test.rb

@@ -15,14 +15,38 @@ describe PaperCup::Response do
   end
 
   describe "when the response is a JSON" do
-    it "must set the response properly" do
-      r = PaperCup::Response.new(Mock.json)
-      assert_equal JSON.parse(Mock.json[0..-4]), r.body
+    describe "and an array" do
+      it "must be an array of RecursiveOpenStruct" do
+        r = PaperCup::Response.new(Mock.json_array)
+        assert_equal 1, r.body.map(&:class).uniq.count, "There must be only one kind of objects"
+        assert_equal RecursiveOpenStruct, r.body.map(&:class).uniq.first, "The class of the elements must be RecursiveOpenStruct"
+      end
+
+      it "must set the response properly" do
+        r = PaperCup::Response.new(Mock.json_array)
+        assert_equal JSON.parse(Mock.json_array[0..-4]).first["framework"], r.body.first.framework
+      end
+
+      it "must set the status code response properly" do
+        r = PaperCup::Response.new(Mock.json_array)
+        assert_equal 200, r.status
+      end
     end
+    describe "and not an array" do
+      it "must be a RecursiveOpenStruct object" do
+        r = PaperCup::Response.new(Mock.json)
+        assert_equal RecursiveOpenStruct, r.body.class, "The class of the elements must be RecursiveOpenStruct"
+      end
 
-    it "must set the status code response properly" do
-      r = PaperCup::Response.new(Mock.json)
-      assert_equal 200, r.status
+      it "must set the response properly" do
+        r = PaperCup::Response.new(Mock.json)
+        assert_equal JSON.parse(Mock.json[0..-4])["framework"], r.body.framework
+      end
+
+      it "must set the status code response properly" do
+        r = PaperCup::Response.new(Mock.json)
+        assert_equal 200, r.status
+      end
     end
   end
 end

data/test/test_helper.rb

@@ -10,10 +10,14 @@ module Mock
       "<html>\n<head>\n<meta charset=\"UTF-8\">\n<title>404</title>\n</head>\n<body>\n<code>404</code>\n</body>\n</html>\n404"
     end
 
-    def json
+    def json_array
       "[{\"framework\":\"Rails\",\"language\":\"ruby\"}]200"
     end
 
+    def json
+      "{\"framework\":\"Rails\",\"language\":\"ruby\"}200"
+    end
+
     def params
       { framework: 'cuba', language: 'ruby' }
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper-cup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mariano Matayoshi
@@ -68,6 +68,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.5
 description: Use curl with Open3 for making request
 email: matayoshi.mariano@gmail.com
 executables: []
@@ -76,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile