micky 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af45a8a8f7fc7e48b95beeffbff81a51e9948ad1
-  data.tar.gz: 057926d44234a5d7cea3205f35e905ee58d9ebeb
+  metadata.gz: d8856a3b9bdf0070da933541f52c3571e5499783
+  data.tar.gz: fbcd0010c28a491fe267a27d0617774906d30b2a
 SHA512:
-  metadata.gz: 0e9b6c1d51655b9e995e4bad8ffe680f8f105a8d29371cbecef8936ac53da0eed02547995e44da155df9d139d44bb1570d044316d58d3631dca734150430c865
-  data.tar.gz: a93d83e01d8511b1c56a4fb00b83ecb0ab8291a4a9d5b45d4148770b074ffb43ff2723d200b5a21bcf1193c964770d06adb42ad0427c7fa4ab3e59e7650c3320
+  metadata.gz: f6f1d6969aa4957ec2983d44b841d3a5515cbadb067858b6b6bf859f785b5e8814e324d06db993cbc5960eda6a1e15d1ecc9bfd228db8f808ac56eadcaa250ee
+  data.tar.gz: 41d5a0daa0d33f7655082863beea63bc6a233f1f5e43e433ed18f90ff5e7d43a7ea6e8b8f82b10886d922802c2ff262de8126784840ecfcfe90ffec93f74f856

data/README.md

@@ -15,15 +15,21 @@ don’t want to add heavy dependencies to your app.
 
 Add this line to your application’s Gemfile:
 
-    gem 'micky'
+```ruby
+gem 'micky'
+```
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install micky
+```sh
+$ gem install micky
+```
 
 ## Usage
 
@@ -61,6 +67,38 @@ else
 end
 ```
 
+### Headers and query strings
+
+Request headers and query string params can be passed as `:headers` and `:query`.
+
+```ruby
+Micky.get('http://drpm.me/unwz.jpg', headers: { 'Accept' => 'text/html' })
+Micky.get('http://urls.api.twitter.com/1/urls/count.json', query: { url: 'dropmeme.com' })
+```
+
+### OAuth `Authorization` header
+
+Micky supports creating a OAuth `Authorization` header with the help of the
+[SimpleOAuth](https://github.com/laserlemon/simple_oauth) gem.
+
+```ruby
+Micky.get(
+  'https://api.twitter.com/1.1/statuses/user_timeline.json',
+  oauth: {
+    consumer_key: 'l0tSAl3tT3RsAnD1G1tS',
+    consumer_secret: 'l0tSAl3tT3RsAnD1G1tS',
+    token: 'l0tSAl3tT3RsAnD1G1tS',
+    token_secret: 'l0tSAl3tT3RsAnD1G1tS',
+  },
+)
+```
+
+To use the `:oauth` argument, just ensure [`simple_oauth`](http://rubygems.org/gems/simple_oauth) is available:
+
+```ruby
+gem 'simple_oauth'
+```
+
 ### Automatically parse responses into Ruby objects
 
 `Micky::Response#body` always returns the response as a string. To parse this
@@ -123,9 +161,9 @@ end
 
 ## TODO
 
+- Support :basic_auth and :digest_auth through [HTTPauth](https://github.com/Manfred/HTTPauth)
 - Add tests
 - Better document configuration options in README
-- Add `raise_errors: true` option
 
 ## Contributing
 

data/lib/micky/errors.rb

@@ -0,0 +1,31 @@
+module Micky
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(response = nil)
+      @response = response
+    end
+
+    def to_s
+      "#{response_code} #{response_message} at #{request_uri}"
+    end
+
+    def request_uri
+      response.uri if response
+    end
+
+    def response_code
+      response.code.to_i if response
+    end
+
+    def response_message
+      response.message if response
+    end
+  end
+
+  class ClientError < Error
+  end
+
+  class ServerError < Error
+  end
+end

data/lib/micky/request.rb

@@ -5,7 +5,7 @@ module Micky
   class Request
     def initialize(opts = {})
       # Options can be set per request and fallback to module-level defaults
-      [:max_redirects, :timeout, :skip_resolve, :resolve_timeout, :oauth, :query, :headers, :parsers].each do |name|
+      [:raise_errors, :max_redirects, :timeout, :skip_resolve, :resolve_timeout, :oauth, :query, :headers, :parsers].each do |name|
         value = opts.has_key?(name) ? opts[name] : Micky.public_send(name)
         instance_variable_set "@#{name}", value
       end
@@ -36,7 +36,17 @@ module Micky
       else
         log response
         log response.body
-        nil
+
+        if @raise_errors
+          case response
+          when Net::HTTPClientError
+            raise Micky::ClientError.new(response)
+          when Net::HTTPServerError
+            raise Micky::ServerError.new(response)
+          end
+        else
+          nil
+        end
       end
     end
 

data/lib/micky/response.rb

@@ -27,12 +27,12 @@ module Micky
     end
 
     def inspect
-      "#<Micky::Reponse #{super}>"
+      "#<Micky::Response #{super}>"
     end
 
     # Support for `awesome_print`
     def ai(*args)
-      "#<Micky::Reponse #{super}>"
+      "#<Micky::Response #{super}>"
     end
   end
 end

data/lib/micky/version.rb

@@ -1,3 +1,3 @@
 module Micky
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/micky.rb

@@ -3,9 +3,11 @@ require 'micky/version'
 require 'micky/uri'
 require 'micky/request'
 require 'micky/response'
+require 'micky/errors'
 
 module Micky
   class << self
+    attr_accessor :raise_errors
     attr_accessor :max_redirects
     attr_accessor :timeout
     attr_accessor :skip_resolve
@@ -17,6 +19,7 @@ module Micky
   end
 
   # Reasonable defaults
+  @raise_errors = false
   @max_redirects = 10
   @timeout = 5
   @skip_resolve = false

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: micky
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rafaël Blais Masson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-17 00:00:00.000000000 Z
+date: 2014-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Micky makes simple HTTP requests (GET/HEAD), follows redirects, handles
@@ -47,12 +47,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/micky.rb
+- lib/micky/errors.rb
 - lib/micky/request.rb
 - lib/micky/response.rb
 - lib/micky/uri.rb
@@ -68,17 +69,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Lightweight and worry-free HTTP client