parsable 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3647c899ec5e6def562f04586513c86e474abf84
-  data.tar.gz: 8bba282b7f3b95fc81df04c3e743ba41a2c6e454
+  metadata.gz: fa26def0d4d25d2a7fbe0cb241a1b87d78d43d81
+  data.tar.gz: 247b83cce85574adca35d3d2e6bfa2e7aaf1f10e
 SHA512:
-  metadata.gz: b58d2729bfe483afa34a9328cc955d8f10bdb49592146cc6eb0bafd4bfb9eb46b9f665324933496095b320c209406e59a2f91cc9acafa2620f1777b5e730a4f9
-  data.tar.gz: 182c30d0c82e7a69b6a8ff9e8ec5b54b4b0bf6dc7cbca2c9076872116598f6410e0d15be4d872419ceec9ec53bdf7bdd22545b6ff8ec88b17da3011c473cae76
+  metadata.gz: 853901451d3865fc969adadc18618063f3238b2d8101c28af8afa1acd037913ad3ff502d4c3191946a7761bba4fc67e7a309d19d969c0f45753c2a3c6e0f5660
+  data.tar.gz: 77ebfb3746e93df6e4ca88a37d886e9a092652ee3b85bbaf760dd09ff940e80aacd094315c713d708e916b7bd8275e3fce28b4677b758b6e23e164b28621ec20

data/fixtures/vcr_cassettes/Parsable_Remote/_method_missing/url/with_query_params/with_secure_request/moves_sensitive_query_params_into_headers.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://httpbin.org/get?unsecure=notsecure
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Api-Key:
+      - flkdsjflksjfejifwf
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Wed, 30 Dec 2015 05:59:13 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '241'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Allow-Credentials:
+      - 'true'
+    body:
+      encoding: ASCII-8BIT
+      string: "{\n  \"args\": {\n    \"unsecure\": \"notsecure\"\n  }, \n  \"headers\":
+        {\n    \"Accept\": \"*/*\", \n    \"Api-Key\": \"flkdsjflksjfejifwf\", \n
+        \   \"Host\": \"httpbin.org\"\n  }, \n  \"origin\": \"107.139.199.11\", \n
+        \ \"url\": \"http://httpbin.org/get?unsecure=notsecure\"\n}\n"
+    http_version: 
+  recorded_at: Wed, 30 Dec 2015 05:59:13 GMT
+recorded_with: VCR 3.0.0

data/lib/parsable/context.rb

@@ -17,6 +17,7 @@ module Parsable
       })
 
       @variables.store(:remote, Parsable::Remote.new)
+      @variables.store(:sremote, Parsable::Remote.new(:secure => true))
     end
 
     def custom_store attribute, value

data/lib/parsable/remote.rb

@@ -5,7 +5,10 @@ module Parsable
   class Remote
     # uses the response from a remote location
 
-    def initialize
+    attr_accessor :secure
+
+    def initialize options={}
+      self.secure = options.fetch(:secure, false)
     end
 
     def method_missing(method_sym, *arguments, &block)
@@ -16,15 +19,24 @@ module Parsable
 
     private
 
+    def perform url, headers={}
+      begin
+        Curl::Easy.perform(url) do |http|
+          headers.each { |header, value| http.headers[header] = value }
+          http.connect_timeout = 2
+          http.on_success { |easy| @body = easy.body_str }
+        end
+      rescue Curl::Err::CurlError
+      end
+    end
+
     def get_response uri
+      transformer = Parsable::UriHelper.new(uri)
+      url = transformer.to_s
+      headers = transformer.secrets
+
       0.upto(2) do |i|
-        begin
-          Curl::Easy.perform(uri.to_s) do |http|
-            http.connect_timeout = 2
-            http.on_success { |easy| @body = easy.body_str }
-          end
-        rescue Curl::Err::CurlError
-        end
+        perform(url, headers)
 
         break if @body
       end

data/lib/parsable/uri_helper.rb

@@ -0,0 +1,43 @@
+module Parsable
+  class UriHelper
+
+    def initialize uri
+      @uri = uri
+    end
+
+    def exploded_query
+      @query ||= original_query.split("&").each_with_object({}) do |query, hash|
+        name, value = query.split("=")
+        hash.store(name, value) if name && value
+      end
+    end
+
+    def query
+      query_hash.each_with_object([]) { |(key, value), array| array.push("#{key}=#{value}") }.join("&")
+    end
+
+    def query_hash
+      exploded_query.reject { |key, value| scrub_param?(key) }
+    end
+
+    def secrets
+      exploded_query.select { |key, value| scrub_param?(key) }
+    end
+
+    def to_s
+      uri = @uri.dup
+      uri.query = query
+      uri.to_s
+    end
+
+    private
+
+    def original_query
+      @uri.query.to_s
+    end
+
+    def scrub_param? param_name
+      !!(param_name =~ /(key|token)/)
+    end
+  end
+end

data/lib/parsable/version.rb

@@ -1,3 +1,3 @@
 module Parsable
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/parsable.rb

@@ -3,6 +3,7 @@ require 'parsable/parser'
 require 'parsable/context'
 require 'parsable/parsed_item'
 require 'parsable/remote'
+require 'parsable/uri_helper'
 
 module Parsable
 

data/spec/remote_spec.rb

@@ -16,6 +16,18 @@ describe Parsable::Remote do
           query = {"args" => {"query1" => "q1", "query2" => "q2"}}
           expect(JSON.parse(subject.send("http://httpbin.org/get?query1=q1&query2=q2"))).to include(query)
         end
+        context "with secure request" do
+
+          subject { described_class.new(:secure => true) }
+
+          it "moves sensitive query params into headers" do
+            query = {"unsecure" => "notsecure"}
+            headers = {"api_key" => "flkdsjflksjfejifwf"}
+            body_hash = JSON.parse(subject.send("http://httpbin.org/get?api_key=flkdsjflksjfejifwf&unsecure=notsecure"))
+            expect(body_hash["args"]).to eql(query)
+            expect(body_hash["headers"]).to include("Api-Key" => "flkdsjflksjfejifwf")
+          end
+        end
       end
 
       context "cant connect" do

data/spec/uri_helper.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Parsable::UriHelper do
+
+  subject { described_class.new(URI.parse("http://httpbin.org/get?unsecure2=notsecure2&secure_api_key=flkdsjflksjfejifwf&unsecure=notsecure&")) }
+
+  describe '#exploded_query' do
+    it "is a hash representation of all query params" do
+      expected = {"unsecure2"=>"notsecure2", "secure_api_key" => "flkdsjflksjfejifwf", "unsecure" => "notsecure" }
+      expect(subject.exploded_query).to eql(expected)
+    end
+
+    context "no query" do
+      subject { described_class.new(URI.parse("http://httpbin.org/get")) }
+      it "is empty" do
+        expect(subject.exploded_query).to eql({})
+      end
+    end
+  end
+
+  describe '#query_hash' do
+    it "does not inlcude sensitve key" do
+      expect(subject.query_hash.keys).to_not include("secure_api_key")
+    end
+
+    it "includes nonsecure param" do
+      expect(subject.query_hash.keys).to include("unsecure")
+    end
+  end
+
+  describe '#query' do
+    it "is joined by &s" do
+      expect(subject.query).to eql("unsecure2=notsecure2&unsecure=notsecure")
+    end
+  end
+
+  describe '#secrets' do
+    it "is a hash" do
+      expect(subject.secrets).to be_kind_of(Hash)
+    end
+
+    it "has secret keys" do
+      expect(subject.secrets.keys).to include("secure_api_key")
+    end
+
+    it 'does not have non secrets' do
+      expect(subject.secrets.keys).to_not include("unsecure", "unsecure2")
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parsable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Hubert Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2015-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,11 +125,13 @@ files:
 - fixtures/vcr_cassettes/Parsable_Remote/_method_missing/url/cant_connect/returns_nil.yml
 - fixtures/vcr_cassettes/Parsable_Remote/_method_missing/url/returns_the_body.yml
 - fixtures/vcr_cassettes/Parsable_Remote/_method_missing/url/with_query_params/uses_them_in_the_request.yml
+- fixtures/vcr_cassettes/Parsable_Remote/_method_missing/url/with_query_params/with_secure_request/moves_sensitive_query_params_into_headers.yml
 - lib/parsable.rb
 - lib/parsable/context.rb
 - lib/parsable/parsed_item.rb
 - lib/parsable/parser.rb
 - lib/parsable/remote.rb
+- lib/parsable/uri_helper.rb
 - lib/parsable/version.rb
 - parsable.gemspec
 - spec/context_spec.rb
@@ -137,6 +139,7 @@ files:
 - spec/parser_spec.rb
 - spec/remote_spec.rb
 - spec/spec_helper.rb
+- spec/uri_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -167,3 +170,4 @@ test_files:
 - spec/parser_spec.rb
 - spec/remote_spec.rb
 - spec/spec_helper.rb
+- spec/uri_helper.rb