frenetic 0.0.1.alpha1 → 0.0.1

data/README.md

@@ -5,108 +5,6 @@
 
 An opinionated Ruby-based Hypermedia API (HAL+JSON) client.
 
-## About
-
-fre&bull;net&bull;ic |frəˈnetik|<br/>
-adjective<br/>
-fast and energetic in a rather wild and uncontrolled way : *a frenetic pace of activity.*
-
-So basically, this is a crazy way to interact with your Hypermedia HAL+JSON API.
-
-Get it? *Hypermedia*?
-
-*Hyper*?
-
-...
-
-If you have not implemented a HAL+JSON API, then this will not work very well for you.
-
-## Opinions
-
-Like I said, it is opinionated. It is so opinionated, it is probably the biggest
-a-hole you've ever met.
-
-Maybe in time, if you teach it, it will become more open-minded.
-
-### HAL+JSON Content Type
-
-Frenetic expects all responses to be in [HAL+JSON][hal_json]. It chose that
-standard because it is trying to make JSON API's respond in a predictable
-manner, which it thinks is an awesome idea.
-
-### Authentication
-
-Frenetic is going to try and use Basic Auth whether you like it or not. If
-that is not required, nothing will probably happen. But its going to send the
-header anyway.
-
-### API Description
-
-The API's root URL must respond with a description, much like the
-[Spire.io][spire.io] API. This is crucial in order for Frenetic to work. If
-Frenetic doesn't know what the API contains, it can't parse any resource
-responses.
-
-It is expected that any subclasses of `Frenetic::Resource` will adhere to the
-schema defined here.
-
-Example:
-
-```js
-{
-  "_links":{
-    "self":{"href":"/api/"},
-    "inkers":{"href":"/api/inkers"},
-  },
-  "_embedded":{
-    "schema":{
-      "_links":{
-        "self":{"href":"/api/schema"}
-      },
-      "order":{
-        "description":"A widget order",
-        "type":"object",
-        "properties":{
-          "id":{"type":"integer"},
-          "first_name":{"type":"string"},
-          "last_name":{"type":"string"},
-        }
-      }
-    }
-  }
-}
-```
-
-This response will be requested by Frenetic whenever a call to
-`YourAPI.description` is made. The response is memoized so any future calls
-will not trigger another API request.
-
-### API Resources
-
-While HAL+JSON is awesome, not all implementations are perfect. Frenetic
-assumes a HAL+JSON response as built by [Roar], which may not be in 100%
-compliance.
-
-Example:
-
-```js
-{
-  "id":1,
-  "first_name":"Foo",
-  "last_name":"Bar",
-  "_links":{
-    "self":{"href":"/order/1"},
-    "next":{"href":"/order/2"}
-  }
-}
-```
-
-The problem here is that the entire response really should be wrapped in
-`"_embedded"` and `"order"` keys.
-
-So until that is fixed, Frenetic will continue to be pig headed and continue
-to do the "wrong" thing.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -123,91 +21,7 @@ Or install it yourself as:
 
 ## Usage
 
-### Client Initialization
-
-```ruby
-MyAPI = Frenetic.new(
-  'url'          => 'https://api.yoursite.com',
-  'username'     => 'yourname',
-  'password'     => 'yourpassword',
-  'headers' => {
-    'accept' => 'application/vnd.yoursite-v1.hal+json'
-    # Optional
-    'user-agent' => 'Your Site's API Client', # Optional custom User Agent, just 'cuz
-  }
-)
-```
-
-### Making Requests
-
-Once you have created a client instance, you are free to use it however you'd
-like.
-
-A Frenetic instance supports any HTTP verb that [Faraday][faraday] has
-impletented. This includes GET, POST, PUT, PATCH, and DELETE.
-
-#### Frenetic::Resource
-
-An easier way to make requests for a resource is to have your model inherit from
-`Frenetic::Resource`. This makes it a bit easier to encapsulate all of your
-resource's API requests into one place.
-
-```ruby
-class Order < Frenetic::Resource
-
-  api_client { MyAPI }
-
-  class << self
-    def find( id )
-      if response = api.get( api.description.links.order.href.gsub('{id}', id.to_s) ) and response.success?
-        self.new( response.body )
-      else
-        raise OrderNotFound, "No Order found for #{id}"
-      end
-    end
-  end
-end
-```
-
-The `api_client` class method merely tells `Frenetic::Resource` which API Client
-instance to use. If you lazily instantiate your client, then you should pass a
-block as demonstrated above.
-
-Otherwise, you may pass by reference:
-
-```ruby
-class Order < Frenetic::Resource
-  api_client MyAPI
-end
-```
-
-When your model is initialized, it will contain attribute readers for every
-property defined in your API's schema or description. In theory, this allows an
-API to add, remove, or change properties without the need to directly update
-your model.
-
-### Interpretting Responses
-
-Any response body returned by a Frenetic generated API call will be returned as
-an OpenStruct-like object. This object responds to dot-notation as well as Hash
-keys and is enumerable.
-
-```ruby
-response.body.resources.orders.first
-```
-
-or
-
-```ruby
-response.body['_embedded']['orders'][0]
-```
-
-For your convenience, certain HAL+JSON keys have been aliased by methods a bit
-more readable:
-
-  * `_embedded` can be referenced as `resources`
-  * `_links` can be referenced as `links`
-  * `href` can be referenced as `url`
+Your guess is as good as mine. (*TODO*)
 
 ## Contributing
 
@@ -216,8 +30,3 @@ more readable:
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-
-[hal_json]: http://stateless.co/hal_specification.html
-[spire.io]: http://api.spire.io/
-[roar]: https://github.com/apotonick/roar
-[faraday]: https://github.com/technoweenie/faraday

data/lib/frenetic.rb

@@ -1,5 +1,4 @@
 require 'addressable/uri'
-require 'patron' # Needed to prevent https://github.com/technoweenie/faraday/issues/140
 require 'faraday'
 
 require "frenetic/configuration"

data/lib/frenetic/configuration.rb

@@ -15,7 +15,11 @@ class Frenetic
       config[:headers]  ||= {}
       config[:request]  ||= {}
 
-      config[:headers][:accept] ||= "application/hal+json"
+      if config[:"content-type"]
+        config[:headers][:accepts] = config[:"content-type"]
+      else
+        config[:headers][:accepts] = "application/hal+json"
+      end
 
       # Copy the config into this Configuration instance.
       config.each { |k, v| self[k] = v }

data/lib/frenetic/version.rb

@@ -1,3 +1,3 @@
 class Frenetic
-  VERSION = "0.0.1.alpha1"
+  VERSION = "0.0.1"
 end

data/spec/lib/frenetic/configuration_spec.rb

@@ -4,9 +4,7 @@ describe Frenetic::Configuration do
     { 'test' => {
         'url'          => 'http://example.org',
         'api_key'      => '1234567890',
-        'headers' => {
-          'accept' => content_type,
-        },
+        'content-type' => content_type,
         'request' => {
           'timeout' => 10000
         }
@@ -39,16 +37,16 @@ describe Frenetic::Configuration do
         subject[:headers][:user_agent].should =~ %r{Frenetic v.+; \S+$}
       end
 
-      context "with a specified Accept header" do
-        it "should set an Accept request header" do
-          subject[:headers].should include(:accept => 'application/vnd.frenetic-v1-hal+json')
+      context "with a specified Content-Type" do
+        it "should set an Accepts request header" do
+          subject[:headers].should include(:accepts => 'application/vnd.frenetic-v1-hal+json')
         end
       end
-      context "without a specified Accept header" do
+      context "without a specified Content-Type" do
         let(:content_type) { nil }
 
-        it "should set an Accept request header" do
-          subject[:headers].should include(:accept => 'application/hal+json')
+        it "should set an Accepts request header" do
+          subject[:headers].should include(:accepts => 'application/hal+json')
         end
       end
     end
@@ -65,7 +63,7 @@ describe Frenetic::Configuration do
         it { should be_a( Hash ) }
         it { should_not be_empty }
         it "should set an Accepts request header" do
-          subject[:headers].should include(:accept => 'application/hal+json')
+          subject[:headers].should include(:accepts => 'application/hal+json')
         end
         it "should set a User Agent request header" do
           subject[:headers][:user_agent].should =~ %r{Frenetic v.+; \S+$}

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: frenetic
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha1
-  prerelease: 6
+  version: 0.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Derek Lindahl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-16 00:00:00.000000000Z
+date: 2012-04-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &2156831400 !ruby/object:Gem::Requirement
+  requirement: &2157361220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.0.rc2
   type: :runtime
   prerelease: false
-  version_requirements: *2156831400
+  version_requirements: *2157361220
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &2156830640 !ruby/object:Gem::Requirement
+  requirement: &2157360720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.2.7
   type: :runtime
   prerelease: false
-  version_requirements: *2156830640
+  version_requirements: *2157360720
 - !ruby/object:Gem::Dependency
   name: patron
-  requirement: &2156829960 !ruby/object:Gem::Requirement
+  requirement: &2157360240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.4.18
   type: :runtime
   prerelease: false
-  version_requirements: *2156829960
+  version_requirements: *2157360240
 - !ruby/object:Gem::Dependency
   name: guard-spork
-  requirement: &2156829240 !ruby/object:Gem::Requirement
+  requirement: &2157359780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2156829240
+  version_requirements: *2157359780
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2156828580 !ruby/object:Gem::Requirement
+  requirement: &2157359320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *2156828580
+  version_requirements: *2157359320
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156827880 !ruby/object:Gem::Requirement
+  requirement: &2157358860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *2156827880
+  version_requirements: *2157358860
 - !ruby/object:Gem::Dependency
   name: bourne
-  requirement: &2156827200 !ruby/object:Gem::Requirement
+  requirement: &2157358400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.1.2
   type: :development
   prerelease: false
-  version_requirements: *2156827200
+  version_requirements: *2157358400
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2156826480 !ruby/object:Gem::Requirement
+  requirement: &2157357940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 1.8.6
   type: :development
   prerelease: false
-  version_requirements: *2156826480
+  version_requirements: *2157357940
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &2156825880 !ruby/object:Gem::Requirement
+  requirement: &2157357480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,7 +109,7 @@ dependencies:
         version: 2.0.1
   type: :development
   prerelease: false
-  version_requirements: *2156825880
+  version_requirements: *2157357480
 description: An opinionated Ruby-based Hypermedia API client.
 email:
 - dlindahl@customink.com
@@ -155,9 +155,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10