http_magic 0.1.1 → 0.1.2

data/.gitignore

@@ -1,7 +1,9 @@
 *.gem
 *.rbc
+*.swp
 .bundle
 .config
+.rvmrc
 coverage
 InstalledFiles
 lib/bundler/man

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    http_magic (0.1.0)
+    http_magic (0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -26,7 +26,7 @@ GEM
     pry-debugger (0.2.2)
       debugger (~> 1.3)
       pry (~> 0.9.10)
-    rake (10.1.1)
+    rake (0.9.6)
     safe_yaml (0.9.7)
     slop (3.4.7)
     webmock (1.16.1)
@@ -38,8 +38,8 @@ PLATFORMS
 
 DEPENDENCIES
   http_magic!
-  minitest (~> 4.7.0)
-  pry
-  pry-debugger
-  rake
-  webmock (~> 1.16.0)
+  minitest (~> 4.7)
+  pry (~> 0)
+  pry-debugger (~> 0)
+  rake (~> 0)
+  webmock (~> 1.16)

data/http_magic.gemspec

@@ -1,7 +1,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'http_magic'
-  s.version = '0.1.1'
+  s.version = '0.1.2'
   s.licenses = ['MIT']
   s.summary = 'Provides a more Object Oriented interface to RESTful apis.'
 

data/lib/http_magic/api.rb

@@ -137,6 +137,26 @@ module HttpMagic
       self
     end
 
+    # Deletes a resource from the URI.
+    #
+    # Assuming an api where each resource is namespaced with 'api/v1' and where
+    # the url http://www.example.com/api/v1/foo/99 references a specific
+    # resource.
+    #
+    # == Example
+    #
+    #   class ExampleApi < HttpMagic::Api
+    #     url 'www.example.com'
+    #     namespace 'api/v1'
+    #   end
+    #
+    #   ExampleApi.foo[99].delete
+    #   => ""
+    def delete
+      request = Request.new(@uri, headers: @headers)
+      request.delete
+    end
+
     # Gets a resource from the URI and returns it based on its content type.
     # JSON content will be parsed and returned as equivalent Ruby objects. All
     # other content types will be returned as text.
@@ -205,6 +225,41 @@ module HttpMagic
       request.post
     end
 
+    # PUT's a resource to the URI and returns the result based on its content
+    # type. JSON content will be parsed and returned as equivalent Ruby objects.
+    # All other content types will be returned as text.
+    #
+    # Assuming an api where each resource is namespaced with 'api/v1' and where
+    # a GET to the url http://www.example.com/api/v1/foo/99 responds with the
+    # following.
+    #
+    # Header:
+    #
+    #   Content-Type: application/json
+    #
+    # Body:
+    #
+    #   {
+    #     "name": "Foo"
+    #   }
+    #
+    # == Example
+    #
+    #   class ExampleApi < HttpMagic::Api
+    #     url 'www.example.com'
+    #     namespace 'api/v1'
+    #   end
+    #
+    #   ExampleApi.foo[99].put(name: 'Changed Foo')
+    #   => { "name" => "Changed Foo" }
+    def put(data = {})
+      request = Request.new(@uri,
+        headers: @headers,
+        data: data,
+      )
+      request.put
+    end
+
     # Instance scoped method_missing that accumulates the URN parts used in
     # forming the URI. It returns a reference to the current instance so that
     # method and [] based parts can be chained together to from the URN. In the

data/lib/http_magic/request.rb

@@ -23,8 +23,24 @@ module HttpMagic
       }
     end
 
+    # Makes a DELETE request to the url provided by the Uri object and returns
+    # the response parsed according to the content type specified in the
+    # repsonse.
+    #
+    # == Example
+    #
+    #   uri_object = HttpMagic::Uri.new('http://example.com')
+    #
+    #   request = Request.new(uri_object)
+    #
+    #   request.delete
+    #   => { 'name' => 'Foo Bar' }
+    def delete
+      parse_response http.delete(@uri.urn, @options[:headers])
+    end
+
     # Makes a GET request to the url provided by the Uri object and returns the
-    # resulting JSON data as a Ruby hash.
+    # response parsed according to the content type specified in the repsonse.
     #
     # == Example
     #
@@ -35,12 +51,13 @@ module HttpMagic
     #   request.get
     #   => { 'name' => 'Foo Bar' }
     def get
-      send_request :get
+      parse_response http.request_get(@uri.urn, @options[:headers])
     end
 
     # Makes a POST request to the url provided by the Uri object and returns the
-    # resulting JSON data as a Ruby hash. If data was provided as an optional
-    # initialization parameter, then that is also POSTed.
+    # response parsed according to the content type specified in the repsonse.
+    # If data was provided as an optional initialization parameter, then that is
+    # also POSTed.
     #
     # == Example
     #
@@ -51,10 +68,38 @@ module HttpMagic
     #   request.post
     def post
       if !@data.empty?
-        @options[:headers].merge!( 'content-type' => 'application/json' )
+        @options[:headers].merge!( 'Content-Type' => 'application/json' )
+      end
+
+      parse_response http.request_post(
+        @uri.urn,
+        @data.to_json,
+        @options[:headers]
+      )
+    end
+
+    # Makes a PUT request to the url provided by the Uri object and returns the
+    # response parsed according to the content type specified in the repsonse.
+    # If data was provided as an optional initialization parameter, then that is
+    # also PUTed.
+    #
+    # == Example
+    #
+    #   uri_object = HttpMagic::Uri.new('http://example.com')
+    #
+    #   request = Request.new(uri_object, data: { name: 'New Foo' })
+    #
+    #   request.put
+    def put
+      if !@data.empty?
+        @options[:headers].merge!( 'Content-Type' => 'application/json' )
       end
 
-      send_request :post
+      parse_response http.request_put(
+        @uri.urn,
+        @data.to_json,
+        @options[:headers]
+      )
     end
 
     private
@@ -66,13 +111,12 @@ module HttpMagic
       @http
     end
 
-    def send_request(method)
-      response = http.send_request(method, @uri.urn, @data.to_json, @options[:headers])
+    def parse_response(response)
       if response && response.is_a?(Net::HTTPSuccess)
-        if response.content_type == 'application/json'
+        if response.body && response.content_type == 'application/json'
           JSON.parse(response.body)
         else
-          response.body
+          response.body.to_s
         end
       else
         nil

data/test/api/delete_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+require 'http_magic'
+
+class HttpMagicTest < HttpMagic::Api
+end
+
+describe 'HttpMagic#delete' do
+  before do
+    @url = HttpMagicTest.url 'www.example.com'
+    HttpMagicTest.namespace nil
+    HttpMagicTest.headers nil
+  end
+
+  it 'should send DELETE request' do
+    stub_delete = stub_request(:delete, "https://#{@url}")
+
+    HttpMagicTest.delete
+    assert_requested stub_delete
+  end
+
+end

data/test/api/put_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+require 'http_magic'
+
+class HttpMagicTest < HttpMagic::Api
+end
+
+describe 'HttpMagic#put' do
+  before do
+    @url = HttpMagicTest.url 'www.example.com'
+    HttpMagicTest.namespace nil
+    HttpMagicTest.headers nil
+  end
+
+  it 'should send PUT request' do
+    stub_put = stub_request(:put, "https://#{@url}")
+
+    HttpMagicTest.put
+    assert_requested stub_put
+  end
+
+  it 'should send data with PUT request' do
+    expected_data = {
+      apple: 'sauce',
+      banana: 'bread'
+    }
+    stub_put = stub_request(:put, "https://#{@url}/foo").with(
+      body: expected_data
+    )
+
+    HttpMagicTest.foo.put(expected_data)
+
+    assert_requested stub_put
+  end
+end

data/test/request_test.rb

@@ -32,6 +32,16 @@ describe 'HttpMagic::Request' do
     assert_equal content, request.get
   end
 
+  it 'should be able to delete a resource' do
+    stub_request = stub_request(:delete, "https://#{@domain}").
+      to_return(status: 204)
+
+    request = HttpMagic::Request.new(@uri)
+    request.delete
+
+    assert_requested stub_request
+  end
+
   it 'should be able to post data as hash' do
     expected_data = {
       apple: 'crispy',
@@ -39,7 +49,7 @@ describe 'HttpMagic::Request' do
     }
     stub_request = stub_request(:post, "https://#{@domain}").with(
       body: expected_data.to_json,
-      headers: { 'content-type' => 'application/json' }
+      headers: { 'Content-Type' => 'application/json' }
     )
 
     request = HttpMagic::Request.new(@uri, data: expected_data)
@@ -48,6 +58,22 @@ describe 'HttpMagic::Request' do
     assert_requested stub_request
   end
 
+  it 'should be able to put data as hash' do
+    expected_data = {
+      apple: 'crispy',
+      banana: 'soft'
+    }
+    stub_request = stub_request(:put, "https://#{@domain}").with(
+      body: expected_data.to_json,
+      headers: { 'Content-Type' => 'application/json' }
+    )
+
+    request = HttpMagic::Request.new(@uri, data: expected_data)
+    request.put
+
+    assert_requested stub_request
+  end
+
   it 'should set correct headers' do
     stub_request = stub_request(:get,  "https://#{@domain}").
       with(headers: { 'X-AuthToken' => 'test_token' })

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: http_magic
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
+  prerelease: 
 platform: ruby
 authors:
 - GradesFirst
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-17 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-debugger
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -97,8 +108,10 @@ files:
 - lib/http_magic/api.rb
 - lib/http_magic/request.rb
 - lib/http_magic/uri.rb
+- test/api/delete_test.rb
 - test/api/get_test.rb
 - test/api/post_test.rb
+- test/api/put_test.rb
 - test/fixtures/projects.json
 - test/request_test.rb
 - test/test_helper.rb
@@ -106,25 +119,26 @@ files:
 homepage: https://github.com/Thoughtwright-LLC/httpmagic
 licenses:
 - MIT
-metadata: {}
 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: 2.2.1
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Provides a more Object Oriented interface to RESTful apis.
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: ae2f80540b2ebc639265dd8a2b4afffa39b72f27
-  data.tar.gz: 38ed7512bca5927a8961ce9279e85b61521902ad
-SHA512:
-  metadata.gz: 0b9c6a898d4172ef774bc79e46a8b714d137270a0022bb3cf09f97d68b6b02e180d151b4d736bd9884b9e010cf8755b9e39c054a9ac95d82584b4f6b1fe4ae84
-  data.tar.gz: 53da0b3b6cdf245d2afcaefd1e0f8c3ab3a4e6522d3e344a1585cf14364a55c774d7ee4492e861bf4f4bb4c62d34b3a8c1d7dae6cc235e80ef2750329b3e9a99