hyperclient 0.4.0 → 0.5.0

data/Gemfile.lock

@@ -1,112 +0,0 @@
-GIT
-  remote: git://github.com/rubyworks/yard-tomdoc
-  revision: e4b09dcd574718bda91d0f956b4dd83246bda273
-  specs:
-    yard-tomdoc (0.7.1)
-      tomparse (>= 0.4.0)
-      yard
-
-PATH
-  remote: .
-  specs:
-    hyperclient (0.4.0)
-      faraday (~> 0.8)
-      faraday_middleware (~> 0.9)
-      futuroscope (>= 0.0.10)
-      net-http-digest_auth (~> 1.2)
-      uri_template (~> 0.5)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.4)
-    ansi (1.4.3)
-    coderay (1.0.9)
-    colorize (0.5.8)
-    crack (0.3.2)
-    faraday (0.8.9)
-      multipart-post (~> 1.2.0)
-    faraday_middleware (0.9.0)
-      faraday (>= 0.7.4, < 0.9)
-    ffi (1.8.1)
-    formatador (0.2.4)
-    futuroscope (0.1.6)
-    gherkin-ruby (0.3.0)
-    growl (1.0.3)
-    guard (1.8.0)
-      formatador (>= 0.2.4)
-      listen (>= 1.0.0)
-      lumberjack (>= 1.0.2)
-      pry (>= 0.9.10)
-      thor (>= 0.14.6)
-    guard-minitest (0.5.0)
-      guard (>= 0.4)
-    guard-spinach (0.0.2)
-      guard (>= 1.1)
-      spinach
-    listen (1.0.3)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-      rb-kqueue (>= 0.2)
-    lumberjack (1.0.3)
-    metaclass (0.0.1)
-    method_source (0.8.1)
-    minitest (3.4.0)
-    mocha (0.13.3)
-      metaclass (~> 0.0.1)
-    multi_json (1.7.2)
-    multipart-post (1.2.0)
-    net-http-digest_auth (1.4)
-    pry (0.9.12.1)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rack (1.5.2)
-    rack-test (0.6.2)
-      rack (>= 1.0)
-    rake (10.0.4)
-    rb-fsevent (0.9.3)
-    rb-inotify (0.9.0)
-      ffi (>= 0.5.0)
-    rb-kqueue (0.2.0)
-      ffi (>= 0.5.0)
-    redcarpet (2.2.2)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    slop (3.4.4)
-    spinach (0.8.2)
-      colorize (= 0.5.8)
-      gherkin-ruby (~> 0.3.0)
-    thor (0.18.1)
-    tomparse (0.4.2)
-    turn (0.9.6)
-      ansi
-    uri_template (0.7.0)
-    webmock (1.11.0)
-      addressable (>= 2.2.7)
-      crack (>= 0.3.2)
-    yard (0.8.6.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  growl
-  guard
-  guard-minitest
-  guard-spinach
-  hyperclient!
-  minitest (~> 3.4.0)
-  mocha (~> 0.13)
-  pry
-  rack-test (~> 0.6)
-  rake
-  redcarpet
-  simplecov
-  spinach
-  turn (~> 0.9)
-  webmock (~> 1.8)
-  yard (~> 0.8)
-  yard-tomdoc!

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2012 Codegram Technologies
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Readme.md

@@ -1,180 +0,0 @@
-# Hyperclient
-[![Build Status](https://secure.travis-ci.org/codegram/hyperclient.png)](http://travis-ci.org/codegram/hyperclient)
-[![Dependency Status](https://gemnasium.com/codegram/hyperclient.png)](http://gemnasium.com/codegram/hyperclient)
-[![Code Climate](https://codeclimate.com/github/codegram/hyperclient.png)](https://codeclimate.com/github/codegram/hyperclient)
-
-Hyperclient is a Ruby Hypermedia API client written in Ruby.
-
-## Documentation
-
-[Hyperclient API documentation on rdoc.info][rdoc]
-
-## Usage
-
-Example API client:
-
-```ruby
-api = Hyperclient.new('http://myapp.com/api').tap do |api|
-  api.digest_auth('user', 'password')
-  api.headers.merge({'accept-encoding' => 'deflate, gzip'})
-end
-```
-
-By default, Hyperclient adds `application/json` as `Content-Type` and `Accept`
-headers. It will also sent requests as JSON and parse JSON responses.
-
-[More examples][examples]
-
-## HAL
-
-Hyperclient only works with JSON HAL friendly APIs. [Learn about JSON HAL][hal].
-
-## Resources
-
-Hyperclient will try to fetch and discover the resources from your API.
-
-### Links
-
-Accessing the links for a given resource is quite straightforward:
-
-```ruby
-api.links.posts_categories
-# => #<Resource ...>
-```
-
-You can also iterate between all the links:
-
-```ruby
-api.links.each do |name, link|
-  puts name, link.url
-end
-```
-
-Actually, you can call any [Enumerable][enumerable] method :D
-
-If a Resource doesn't have friendly name you can always access it as a Hash:
-
-```ruby
-api.links['http://myapi.org/rels/post_categories']
-```
-
-### Embedded resources
-
-Accessing embedded resources is similar to accessing links:
-
-```ruby
-api.embedded.posts
-```
-
-And you can also iterate between them:
-
-```ruby
-api.embedded.each do |name, resource|
-  puts name, resource.attributes
-end
-```
-
-You can even chain different calls (this also applies for links):
-
-```ruby
-api.embedded.posts.first.links.author
-```
-
-### Attributes
-
-Not only you might have links and embedded resources in a Resource, but also
-its attributes:
-
-```ruby
-api.embedded.posts.first.attributes
-# => {title: 'Linting the hell out of your Ruby classes with Pelusa',
-      teaser: 'Gain new insights about your code thanks to static analysis',
-      body:   '...' }
-```
-
-You can access the attribute values via attribute methods, or as a hash:
-
-```ruby
-api.embedded.posts.first.attributes.title
-# => 'Linting the hell out of your Ruby classes with Pelusa'
-
-api.embedded.posts.first.attributes['title']
-# => 'Linting the hell out of your Ruby classes with Pelusa'
-
-api.embedded.posts.first.attributes.fetch('title')
-# => 'Linting the hell out of your Ruby classes with Pelusa'
-```
-
-### HTTP
-
-OK, navigating an API is really cool, but you may want to actually do something
-with it, right?
-
-Hyperclient uses [Faraday][faraday] under the hood to perform HTTP calls. You can
-call any valid HTTP method on any Resource:
-
-```ruby
-post = api.embedded.posts.first
-post.get
-post.head
-post.put({title: 'New title'})
-post.patch({title: 'New title'})
-post.delete
-post.options
-
-posts = api.links.posts
-posts.post({title: "I'm a blogger!", body: 'Wohoo!!'})
-```
-
-If you have a templated link you can expand it like so:
-
-```ruby
-api.links.post.expand(:id => 3).first
-# => #<Resource ...>
-```
-
-You can access the Faraday connection (to add middlewares or do whatever
-you want) by calling `connection` on the entry point. As an example, you could use the [faraday-http-cache-middleware](https://github.com/plataformatec/faraday-http-cache)
-:
-
-```ruby
-api.connection.use :http_cache
-```
-
-## Other
-
-There's also a PHP library named [HyperClient](https://github.com/FoxyCart/HyperClient), if that's what you were looking for :)
-
-## TODO
-
-* Resource permissions: Using the `Allow` header Hyperclient should be able to
-  restrict the allowed method on a given `Resource`.
-* Curie syntax support for links (see http://tools.ietf.org/html/draft-kelly-json-hal-03#section-8.2)
-* Profile support for links
-
-
-## Contributing
-
-* [List of hyperclient contributors][contributors]
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add specs for it. This is important so we don't break it in a future
-  version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  If you want to have your own version, that is fine but bump version
-  in a commit by itself I can ignore when I pull.
-* Send me a pull request. Bonus points for topic branches.
-
-## License
-
-MIT License. Copyright 2012 [Codegram Technologies][codegram]
-
-[hal]: http://stateless.co/hal_specification.html
-[contributors]: https://github.com/codegram/hyperclient/contributors
-[codegram]: http://codegram.com
-[documentup]: http://codegram.github.com/hyperclient
-[faraday]: http://github.com/lostisland/faraday
-[examples]: http://github.com/codegram/hyperclient/tree/master/examples
-[enumerable]: http://ruby-doc.org/core-1.9.3/Enumerable.html
-[rdoc]: http://rubydoc.org/github/codegram/hyperclient/master/frames

data/examples/cyberscore.rb

@@ -1,76 +0,0 @@
-require 'hyperclient'
-
-class Cyberscore
-  include Hyperclient
-
-  def news
-    client.links.submissions.embedded.news
-  end
-
-  def submissions
-    client.links..submissions.embedded.submissions
-  end
-
-  def games
-    client.links.games.embedded.games
-  end
-
-  def add_game(name)
-    client.links.submissions.post({name: name})
-  end
-
-  def motd
-    client.attributes.motd
-  end
-
-  def method_missing(method, *args, &block)
-    if client.respond_to?(method)
-      client.send(method, *args, &block)
-    else
-      super
-    end
-  end
-
-  private
-  def client
-    @client ||= Hyperclient::EntryPoint.new 'http://cs-api.heroku.com/api', 
-                {debug: false, headers: {'content-type' => 'application/json'}}
-  end
-end
-
-def print_links(links)
-  links.each do |name, link|
-    if link.is_a?(Array)
-      print_links(link)
-    else
-      puts %{Found "#{name}" at "#{link.url}" }
-    end
-  end
-end
-
-def print_games(games)
-  games.each do |game|
-    puts %{Found "#{game.attributes['name']}" }
-  end
-end
-
-
-api = Cyberscore.new
-
-puts "Let's inspect the API:"
-puts "\n"
-
-puts 'Links from the entry point:'
-print_links(api.links)
-puts "\n"
-
-puts 'How is the server feeling today?'
-puts api.motd
-puts "\n"
-
-puts "Let's read the news:"
-print_links(api.links.news.links)
-puts "\n"
-
-puts "I like games!"
-print_games(api.games)

data/examples/hal_shop.rb

@@ -1,53 +0,0 @@
-require 'hyperclient'
-require 'pp'
-
-def print_resources(resources)
-  resources.each do |name, resource|
-    begin
-      puts %{Found #{name} at #{resource.url}}
-    rescue
-      puts %{Found #{name}}
-    end
-  end
-end
-
-def print_attributes(attributes)
-  puts "-----------------------------"
-  attributes.each do |attribute, value|
-    puts %{#{attribute}: #{value}}
-  end
-end
-
-api = Hyperclient::EntryPoint.new 'http://hal-shop.heroku.com'
-
-puts "Let's inspect the API:"
-puts "\n"
-
-puts 'Links from the entry point:'
-
-print_resources(api.links)
-
-puts
-puts "Let's see what stats we have:"
-print_attributes(api.embedded.stats.attributes)
-
-products = api.links["http://hal-shop.heroku.com/rels/products"].resource
-
-puts 
-puts "And what's the inventory of products?"
-puts products.attributes['inventory_size']
-
-puts
-puts 'What embedded resources does products have?'
-products.embedded.products.each do |product|
-  puts 'Product:'
-  print_attributes(product.attributes)
-  puts
-end
-
-puts 'And links?'
-print_resources(products.links)
-
-puts
-puts 'Attributes of the first product?'
-print_attributes(products.embedded.products.first.attributes)

data/lib/faraday/request/digest_authentication.rb

@@ -1,85 +0,0 @@
-require 'faraday'
-require 'net/http/digest_auth'
-
-module Faraday
-  # Public: A Faraday middleware to use digest authentication. Since order of
-  # middlewares do care, it should be the first one of the Request middlewares
-  # in order to work properly (due to how digest authentication works).
-  #
-  # If some requests using the connection don't need to use digest auth you
-  # don't have to worry, the middleware will do nothing.
-  #
-  # It uses Net::HTTP::DigestAuth to generate the authorization header but it
-  # should work with any adapter.
-  #
-  # Examples:
-  #
-  #   connection = Faraday.new(...) do |connection|
-  #     connection.request :digest, USER, PASSWORD
-  #   end
-  #
-  #   # You can also use it later with a connection:
-  #   connection.digest_auth('USER', 'PASSWORD')
-  #
-  class Request::DigestAuth < Faraday::Middleware
-
-    # Public: Initializes a DigestAuth.
-    #
-    # app      - The Faraday app.
-    # user     - A String with the user to authentication the connection.
-    # password - A String with the password to authentication the connection.
-    def initialize(app, user, password)
-      super(app)
-      @user, @password = user, password
-    end
-
-    # Public: Sends a first request with an empty body to get the
-    # authentication headers and then send the same request with the body and
-    # authorization header.
-    #
-    # env - A Hash with the request environment.
-    #
-    # Returns a Faraday::Response.
-    def call(env)
-      response = handshake(env)
-      return response unless response.status == 401
-
-      env[:request_headers]['Authorization'] = header(response)
-      @app.call(env)
-    end
-
-    private
-    # Internal: Sends the the request with an empry body.
-    #
-    # env - A Hash with the request environment.
-    #
-    # Returns a Faraday::Response.
-    def handshake(env)
-      env_without_body = env.dup
-      env_without_body.delete(:body)
-
-      @app.call(env_without_body)
-    end
-
-    # Internal: Builds the authorization header with the authentication data.
-    #
-    # response - A Faraday::Response with the authenticate headers.
-    #
-    # Returns a String with the DigestAuth header.
-    def header(response)
-      uri = response.env[:url]
-      uri.user = @user
-      uri.password = @password
-
-      realm = response.headers['www-authenticate']
-      method = response.env[:method].to_s.upcase
-
-      Net::HTTP::DigestAuth.new.auth_header(uri, realm, method)
-    end
-  end
-end
-
-# Register the middleware as a Request middleware with the name :digest
-registry = [Faraday, Faraday::Middleware].find{|mod| mod.respond_to?(:register_middleware)}
-raise "Could not find method register_middleware on Faraday or Faraday::Middleware" unless registry
-registry.register_middleware :request, digest: Faraday::Request::DigestAuth