atum 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0b9ba1fb63a78a094276824c8be41879abc25d0
-  data.tar.gz: 4f0c9b0c7866616dc47f5516f60d7e358ca328e8
+  metadata.gz: e3b4f88a40552482c7b7db6d3f8c273ca8dd86e8
+  data.tar.gz: 0bf525b21bba1cca79a48cab6e78a06c647bf3c4
 SHA512:
-  metadata.gz: a7b7374d8dfb2c130bc86cecbc1b7739a1a20c99ae54043e152cd2babc83a556a29afd450f12da1794f83768ea956a637557ea92f37215d182186cb08d7888df
-  data.tar.gz: 50a15f227816f55147a512864cdacd6bdca25ce3a7a5cfcd68c8f34919660c052385c482bcd70a8b79f449e8de9825b00550874d797faffbe60c4cc6fe8eed71
+  metadata.gz: 4ba17fd52fdf6dda1241ece37036e07904105fbaa682206cfa5c1b620c7e45bd42c6d4695672a18915244934bb388966e5bff91a327d2df91a65388006546bed
+  data.tar.gz: 689cef30df036f8368f00e4d877ecac77f6dc266836dfd23cbea8ed165b28e93e15f4e04cf1b2a12192da45d115642ad10431b30c78022b9ad610e1f4dfabda1

data/README.md

@@ -24,7 +24,7 @@ in Atum's spec fixtures
 
 #### 1. Create a New Gem
 
-To generate a new rubygem client, you can run:
+To generate a new rubygem client (for our ficitional *Fruity* API), you can run:
 
 ```
 $ atum new fruity-api
@@ -32,11 +32,11 @@ $ atum new fruity-api
 
 This will does several things:
 
-- Createa a new gem called fruity-api in a `fruity-api` folder in the current
+- Creates a new gem called `fruity-api` in a `fruity-api` folder in the current
    directory
 
    ```
-> atum new fruity-api
+$ atum new fruity-api
       create  fruity-api/Gemfile
       create  fruity-api/Rakefile
       create  fruity-api/LICENSE.txt
@@ -74,13 +74,13 @@ If your client needs to pass custom headers with each request these can be
 specified using `--default-headers or -H`:
 
 ```
-atum generate -H 'Accept: application/vnd.myapp+json; version=3'
+$ atum generate -H 'Accept: application/vnd.myapp+json; version=3'
 ```
 
 To pass multiple headers, just give multiple strings:
 
 ```
-atum generate -H 'header1' 'header2' 'header3'
+$ atum generate -H 'header1' 'header2' 'header3'
 ```
 
 You can also define a default\_headers section in your .atum.yml file.
@@ -96,7 +96,7 @@ default_headers:
 The generated client has [Yard](http://yardoc.org/)-compatible docstrings. You can therefore generate documentation using `yard`:
 
 ```
-yard doc -m markdown .
+$ yard doc -m markdown .
 ```
 
 This will generate HTML in the `docs` directory.  Note that Yard creates an
@@ -131,7 +131,7 @@ Assuming the error response form the server is in JSON format, like:
 }
 ```
 
-Atum will return an Atum::Core::ApiError error. You can access the raw hash (unenveloped) via a `.errors` method, otherwise the error message will contain the error's message and a link to the documentation if it exists.
+Atum will return an Atum::Core::ApiError error. You can access the raw hash (unenveloped) via a `.errors` method, by default the error message will contain the error's message and a link to the documentation if it exists.
 
 
 

data/lib/atum/core/link.rb

@@ -18,9 +18,16 @@ module Atum
       #   include:
       #   - default_headers: Optionally, a set of headers to include in every
       #     request made by the client.  Default is no custom headers.
+      #   - http_adapter: Optionally, the http adapter to use; for now we accept
+      #     adapters according to Faraday's builder:
+      #     https://github.com/lostisland/faraday/blob/v0.8.9/lib/faraday/builder.rb
+      #     e.g. http_adapter: [:rack, Rails.application]
       def initialize(url, link_schema, options = {})
         root_url, @path_prefix = unpack_url(url)
-        @connection = Faraday.new(url: root_url)
+        http_adapter = options[:http_adapter] || [:net_http]
+        @connection = Faraday.new(url: root_url) do |faraday|
+          faraday.adapter(*http_adapter)
+        end
         @link_schema = link_schema
         @headers = options[:default_headers] || {}
       end

data/lib/atum/version.rb

@@ -1,3 +1,3 @@
 module Atum
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/spec/integration/client_integration_spec.rb

@@ -117,4 +117,18 @@ describe 'The Generated Client' do
       expect(Fruity::VERSION).to eq(version)
     end
   end
+
+  context 'when using a :test http_adapter' do
+    before do
+      stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get("#{url}/lemon") { |_| [200, {}, 5] }
+      end
+      Fruity.connect(url, 'USER', 'PASSWORD',
+                     http_adapter: [:test, stubs])
+    end
+
+    it 'uses the defined stubs' do
+      expect(Fruity.lemon.list).to eq(5)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atum
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - isaacseymour
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler