heroics 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16b5b5b9ec40a80d7ac06af58ebf2be1e0c773fe
-  data.tar.gz: a695f11ee1b3eb7841def942d6239c3a589c0fba
+  metadata.gz: 2cbe04afb5b59a688197d7b89d4cae7988681347
+  data.tar.gz: 6e5f0fdf59a60dbf4547befbf281d2e00a0affc3
 SHA512:
-  metadata.gz: 3a4e120811c3b4cef5d0cd919173c9b89e8e2b39834bbc103681056fa3e4355b371ff9a7cf27c1b22b3114e1c962f9c6fe45cf11a9a4d5317e9d6ce9d64e5e97
-  data.tar.gz: 5ad761a53a1baeb2cbbc6d33aa0239c4742eb61406194a0e68b551ea6283372c84f320b631d255bdbd8e7eba524bf86e284eded0d4576d654390f444f73bb983
+  metadata.gz: 5a4272a774738e39cb87a6af8cbdbbed75adc043ee6fdd9bec905481f54d200c13e4ae51b97c88d3a29f282616332a917af81aa9d196c38a3124f41c07144926
+  data.tar.gz: 33ba2968b0cc98b836ecb1a4c5a177986b448c4da43578e4404c0a6915ab73bfe6e4fc45079e597ee9fad6e41ddcffddfdf8635a9244b36b49b31d7fb1e4574d

data/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+## Contributing
+
+We welcome contributions to Heroics and discussion about its design and
+functionality.  Please open an issue or pull request on this repository to
+propose a change.

data/CONTRIBUTORS.md

@@ -0,0 +1,7 @@
+Andrea Salicetti <andrea.salicetti@gmail.com>
+Jamu Kakar <jkakar@kakar.ca>
+Jonathan Roes <jroes@jroes.net>
+Mark Fine <mark.fine@gmail.com>
+Mark McGranaghan <mmcgrana@gmail.com>
+Neil Middleton <neil@heroku.com>
+Wesley Beary <geemus+github@gmail.com>

data/README.md

@@ -27,7 +27,7 @@ JSON schema.  When you have a JSON schema prepared you can generate a client
 for your API:
 
 ```
-bin/heroics-generator MyApp schema.json https://api.myapp.com > client.rb
+bin/heroics-generate MyApp schema.json https://api.myapp.com > client.rb
 ```
 
 ### Passing custom headers
@@ -36,7 +36,7 @@ If your client needs to pass custom headers with each request these can be
 specified using `-H`:
 
 ```
-bin/heroics-generator \
+heroics-generate \
   -H "Accept: application/vnd.myapp+json; version=3" \
   MyApp \
   schema.json \
@@ -52,7 +52,7 @@ default, this data is cached in memory and is only used during the lifetime of
 a single instance.  You can specify a directory for cache data:
 
 ```
-bin/heroics-generator \
+heroics-generate \
   -c "~/.heroics/myapp" \
   MyApp \
   schema.json \
@@ -73,13 +73,9 @@ yard doc -m markdown client.rb
 ```
 
 This will generate HTML in the `docs` directory.  Note that Yard creates an
-`_index.html` page that doesn't appear to be compatible with GitHub Pages.  If
-you're hosting your content there you can change the links:
-
-```
-cd docs
-sed -e 's/_index\.html/index\.html/g' -i `grep _index.html * -rl`
-```
+`_index.html` page won't be served by Jekyll on GitHub Pages.  Add a
+`.nojekyll` file to your project to prevent GitHub from passing the content
+through Jekyll.
 
 ### Handling failures
 

data/lib/heroics/client.rb

@@ -27,7 +27,11 @@ module Heroics
 
     # Get a simple human-readable representation of this client instance.
     def inspect
-      "#<Heroics::Client url=\"#{@url}\">"
+      url = URI.parse(@url)
+      unless url.password.nil?
+        url.password = 'REDACTED'
+      end
+      "#<Heroics::Client url=\"#{url.to_s}\">"
     end
     alias to_s inspect
   end

data/lib/heroics/version.rb

@@ -1,3 +1,3 @@
 module Heroics
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/lib/heroics/views/client.erb

@@ -11,47 +11,30 @@ require 'uri'
 module <%= @module_name %>
   # Get a Client configured to use HTTP Basic authentication.
   #
-  # @param username [String] The username to use with the API.
-  # @param password [String] The password to use with the API.
-  # @param headers [Hash<String,String>] Optionally, custom to headers to
-  #   include with every response.
+  # @param api_key [String] The API key to use when connecting.
+  # @param options [Hash<Symbol,String>] Optionally, custom settings
+  #   to use with the client.  Allowed options are `default_headers`,
+  #   `cache` and `host`.
   # @return [Client] A client configured to use the API with HTTP Basic
   #   authentication.
-  def self.connect(username, password, headers=nil)
-    url = URI.parse("<%= @url %>")
-    url.user = username
-    url.password = password
-    default_headers = <%= @default_headers %>
-    unless headers.nil?
-      default_headers.merge!(headers)
-    end
-    cache = <%= @cache %>
-    options = {
-      default_headers: default_headers,
-                cache: cache
-    }
-    client = Heroics.client_from_schema(SCHEMA, url.to_s, options)
+  def self.connect(api_key, options=nil)
+    options = custom_options(options)
+    url = "https://:#{api_key}@#{options[:host]}"
+    client = Heroics.client_from_schema(SCHEMA, url, options)
     Client.new(client)
   end
 
   # Get a Client configured to use OAuth authentication.
   #
   # @param oauth_token [String] The OAuth token to use with the API.
-  # @param headers [Hash<String,String>] Optionally, custom to headers to
-  #   include with every response.
+  # @param options [Hash<Symbol,String>] Optionally, custom settings
+  #   to use with the client.  Allowed options are `default_headers`,
+  #   `cache` and `host`.
   # @return [Client] A client configured to use the API with OAuth
   #   authentication.
-  def self.connect_oauth(oauth_token, headers=nil)
+  def self.connect_oauth(oauth_token, options=nil)
+    options = custom_options(options)
     url = "<%= @url %>"
-    default_headers = <%= @default_headers %>
-    unless headers.nil?
-      default_headers.merge!(headers)
-    end
-    cache = <%= @cache %>
-    options = {
-      default_headers: default_headers,
-                cache: cache
-    }
     client = Heroics.oauth_client_from_schema(oauth_token, SCHEMA, url, options)
     Client.new(client)
   end
@@ -59,25 +42,45 @@ module <%= @module_name %>
   # Get a Client configured to use Token authentication.
   #
   # @param token [String] The token to use with the API.
-  # @param headers [Hash<String,String>] Optionally, custom to headers to
-  #   include with every response.
+  # @param options [Hash<Symbol,String>] Optionally, custom settings
+  #   to use with the client.  Allowed options are `default_headers`,
+  #   `cache` and `host`.
   # @return [Client] A client configured to use the API with OAuth
   #   authentication.
-  def self.connect_token(token, headers=nil)
+  def self.connect_token(token, options=nil)
+    options = custom_options(options)
     url = "<%= @url %>"
-    default_headers = <%= @default_headers %>
-    unless headers.nil?
-      default_headers.merge!(headers)
+    client = Heroics.token_client_from_schema(token, SCHEMA, url, options)
+    Client.new(client)
+  end
+
+  # Get customized options.
+  def self.custom_options(options)
+    return default_options if options.nil?
+
+    final_options = default_options
+    if options[:default_headers]
+      final_options[:default_headers].merge!(options[:default_headers])
     end
+    final_options[:cache] = options[:cache] if options[:cache]
+    final_options[:host] = options[:host] if options[:host]
+    final_options
+  end
+
+  # Get the default options.
+  def self.default_options
+    default_headers = <%= @default_headers %>
     cache = <%= @cache %>
-    options = {
+    uri = URI.parse("<%= @url %>")
+    {
       default_headers: default_headers,
-                cache: cache
+      cache:           cache,
+      host:            uri.host
     }
-    client = Heroics.token_client_from_schema(token, SCHEMA, url, options)
-    Client.new(client)
   end
 
+  private_class_method :default_options, :custom_options
+
   # <%= @description %>
   class Client
     def initialize(client)

data/test/client_test.rb

@@ -4,10 +4,11 @@ class ClientTest < MiniTest::Unit::TestCase
   include ExconHelper
 
   # Client.to_s returns a simple human-readable description of the client
-  # instance with the URL embedded in it.
+  # instance with the URL embedded in it.  A password, if present in the URL,
+  # is redacted to avoid leaking credentials.
   def test_to_s
     client = Heroics::Client.new({}, 'http://foo:bar@example.com')
-    assert_equal('#<Heroics::Client url="http://foo:bar@example.com">',
+    assert_equal('#<Heroics::Client url="http://foo:REDACTED@example.com">',
                  client.to_s)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroics
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - geemus
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,6 +149,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CONTRIBUTING.md
+- CONTRIBUTORS.md
 - Gemfile
 - LICENSE.txt
 - README.md