url_signer 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49fa2bf8648727c23d178c1e56fe48292ad9072f
-  data.tar.gz: 838502de43dea1e2811b34d84c5f45c3855980d7
+  metadata.gz: 56366ad2bd9634d9a762f6e0759dba5738656f18
+  data.tar.gz: 9917576c556cfe739a5c4a90a3a126041f86a665
 SHA512:
-  metadata.gz: af6a065fff64fcc206865a2efd0811dbd7e70ccb559ba2ac59afc6fbf8c9311c32fbb9e9135b3e7b911edba5b20c29a77c54fea1828255e4fb0ce2779299eaa4
-  data.tar.gz: 8b12be5dafbde8ae03e3ec96c515a543b807b0283d551335502724168427b21fe38cb744d462b5225c4273032fa7484f4b68cb1c6d2b0460c92a60e58fc8c1d9
+  metadata.gz: d38f39b64abaf780b9d366c399b359487772083a0c5f02b6b93c108c6414c233d11f824cc2a6ef4c536a36cbaa092a4f1102715ca3e5ad6d355968420f4d4c9d
+  data.tar.gz: 7f0c6eb90f44434f807c363048f686fb0d5a12343898111f3fbf010dad6a5b62614b4a3972c2fcf853f38d5998f0a5c2b2815b2e7a0869730d7028c36bdd184c

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/README.md

@@ -1,4 +1,6 @@
 # UrlSign
+[![Build Status](https://travis-ci.org/ushu/url_signer.svg?branch=master)](https://travis-ci.org/ushu/url_signer)
+[![Code Climate](https://codeclimate.com/github/ushu/url_signer/badges/gpa.svg)](https://codeclimate.com/github/ushu/url_signer)
 
 Quickly generate and verify signed urls.
 
@@ -39,6 +41,22 @@ Given a signed URL, you can check its authenticity by calling `UrlSigner.valid?`
 true
 ```
 
+### helper methods
+
+The gem adds helper methods to <tt>String</tt> and <tt>URI</tt> classes:
+
+```ruby
+# to generate a signed uri directly form a string
+signed_url = 'http://google.fr'.to_signed_uri(key: 'test')
+
+# or if we have a URI insance already
+url = URI.parse('http://google.fr')
+signed_url = url.signed(key: 'test')
+
+# finally to check for signature authenticity
+signed_url.signature_valid?(key: 'test')
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/url_sign/fork )

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
 
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+end
+

data/lib/url_signer/extensions/string.rb

@@ -0,0 +1,13 @@
+require 'uri'
+require 'url_signer'
+
+class String
+
+  # Return a signed <tt>URI</tt> form the current <tt>String</tt>.
+  #
+  #   'http://google.fr'.to_signed_uri # => <URI::HTTP...>
+  def to_signed_uri(*options)
+      UrlSigner.sign(self, *options)
+  end
+
+end

data/lib/url_signer/extensions/uri.rb

@@ -0,0 +1,24 @@
+require 'uri'
+require 'url_signer'
+
+module URI
+  class Generic
+
+    # Return a signed version of the <tt>URI</tt>.
+    #
+    #   url = URI.parse('http://google.fr')
+    #   signed_url = url.signed
+    def signed(*options)
+      UrlSigner.sign(self, *options)
+    end
+
+    # Checks the validity of the current <tt>URI</tt> signature.
+    #
+    #   signed_url = URI.parse('http://google.fr').signed
+    #   signed_url.signature_valid? # => true
+    def signature_valid?(*options)
+      UrlSigner.valid?(self, *options)
+    end
+
+  end
+end

data/lib/url_signer/version.rb

@@ -1,3 +1,3 @@
 module UrlSigner
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/lib/url_signer.rb

@@ -42,3 +42,8 @@ module UrlSigner
   end
 
 end
+
+# Insert helpers in URI
+require 'url_signer/extensions/uri'
+# Insert helpers in String
+require 'url_signer/extensions/string'

data/spec/string_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe "String extension" do
+  let(:url_string) { 'http://google.fr' }
+  let(:url) { URI.parse(url_string) }
+  let(:signed_url) { UrlSigner.sign(url, key: 'toto') }
+
+  describe "#to_signed_uri" do
+    it "returns a signed version of the URI" do
+      expect(url_string.to_signed_uri(key: 'toto')).to eq(signed_url)
+    end
+  end
+
+end # URI extension

data/spec/uri_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe "URI extension" do
+  let(:url) { URI.parse('http://google.fr') }
+  let(:signed_url) { UrlSigner.sign(url, key: 'toto') }
+
+  describe "#signed" do
+    it "returns a signed version of the URI" do
+      expect(url.signed(key: 'toto')).to eq(signed_url)
+    end
+  end
+
+  describe "#valid" do
+    it "returns true if the current url is signed" do
+      expect(signed_url.signature_valid?(key: 'toto')).to eq(true)
+    end
+  end
+
+end # URI extension

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: url_signer
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Aurélien Noce
@@ -14,42 +14,42 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 description: Simple solution (2 methods) to sign URLs and verify the generated URLs.
@@ -60,19 +60,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/url_signer.rb
 - lib/url_signer/base.rb
+- lib/url_signer/extensions/string.rb
+- lib/url_signer/extensions/uri.rb
 - lib/url_signer/signer.rb
 - lib/url_signer/verifier.rb
 - lib/url_signer/version.rb
 - spec/base_spec.rb
 - spec/signer_spec.rb
 - spec/spec_helper.rb
+- spec/string_spec.rb
+- spec/uri_spec.rb
 - spec/url_signer_spec.rb
 - spec/verifier_spec.rb
 - url_signer.gemspec
@@ -86,17 +91,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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Sign and verify URLs
@@ -104,6 +109,7 @@ test_files:
 - spec/base_spec.rb
 - spec/signer_spec.rb
 - spec/spec_helper.rb
+- spec/string_spec.rb
+- spec/uri_spec.rb
 - spec/url_signer_spec.rb
 - spec/verifier_spec.rb
-has_rdoc: