pco-url 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a6bcb896c6899ae3d2c38e9e6f0bdf3a4101a38
-  data.tar.gz: de4d8e15837e4d36336f8abdd69f26d588cf2683
+  metadata.gz: ed356d2dbbab3e8708ea65a815ca446bcd3e03f4
+  data.tar.gz: 9cd7d6c4b34c7a5ae5bbfd8c09d223e6eb41cb81
 SHA512:
-  metadata.gz: 13b1f0a753ad9d5fdd13833f036101d0b852b94548e62c4a9c984cfa60b8a1f88d61b48333dcd9b953a2680f7f9ff260ca57183368937f96abeca51f2ff754a5
-  data.tar.gz: 6f4d1334ab40d917974c7c0a55c6a50f66d4d13a8d3d9899ac03c48ebbeb7e767c82836be2688352feb27b700df560efd6589be78de038ba78fe63dd1c43ee2f
+  metadata.gz: ebdba2d53cc88b853682bde6c207878c6a5101050031327b6b43ddddf1f2e37f422118c5abc4abd34333b7ed220e9e6ad55c2252eb97e162d8049bf548299e01
+  data.tar.gz: aaaa5009648ba29dee52ab3d6065069d9494d48ac9b7b8e241a922f399170d91142947828eaae423d7e1c0010b5edb9e6a031ce678965851380a8e9f32f975dc

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 James Miller
+Copyright (c) 2015 James Miller
 
 MIT License
 

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.2.1

data/lib/pco/url/version.rb

@@ -1,5 +1,5 @@
 module PCO
   class URL
-    VERSION = "1.3.0"
+    VERSION = "1.4.0"
   end
 end

data/lib/pco/url.rb

@@ -1,48 +1,110 @@
 require "pco/url/version"
-require 'uri'
+require "uri"
+require "URLcrypt"
 
 module PCO
   class URL
-
     class << self
+      def decrypt_query_params(string)
+        URLcrypt.decrypt(string)
+      end
+
+      def parse(string)
+        if uri = URI.parse(string)
+          app_name = uri.host.match(/(\w+)(-staging)?/)[1]
+
+          if uri.query
+            if encrypted_part = encrypted_query_string(uri.query)
+              uri.query.sub!("_e=#{encrypted_part}", decrypt_query_params(encrypted_part))
+            end
+          end
+
+          new(app_name: app_name, path: uri.path, query: uri.query)
+        else
+          raise InvalidPCOURLString, "Unrecognized PCO::URL url string"
+        end
+      end
+
       def method_missing(method_name, *args)
-        url_for_app_with_path(method_name, args)
+        path = args.map { |p| p.sub(/\A\/+/, "").sub(/\/+\Z/, "") }.join("/")
+        new(app_name: method_name, path: path).to_s
       end
 
       private
 
-      def env
-        ENV["DEPLOY_ENV"] || Rails.env
+      def encrypted_query_string(query_params)
+        if query_params =~ encrypted_params_regex
+          Regexp.last_match(:param)
+        end
       end
 
-      def env_url(app_name)
-        env_var  = app_name.to_s.upcase + "_URL"
-        ENV[env_var]
+      def encrypted_params_regex
+        /^_e=(?<param>[^\&]*)/
       end
+    end
 
-      def url_for_app_with_path(app_name, paths)
-        path = paths.map { |p| p.sub(/\A\/+/, "").sub(/\/+\Z/, "") }.join("/")
+    attr_reader :app_name
+    attr_reader :path
+    attr_reader :query
 
-        URI::join(url_for_app(app_name), path).to_s
+    def initialize(app_name:, path: nil, query: nil, encrypt_query_params: false)
+      @app_name       = app_name.to_s.gsub("_", "-")
+      @path           = path
+
+      if query
+        @query = encrypt_query_params ? "_e=#{URLcrypt.encrypt(query)}" : query
       end
+    end
 
-      def url_for_app(app_name)
-        # Try "CHECK_INS_URL" then url_for_app("check-ins")
-        return env_url(app_name) if env_url(app_name)
+    def scheme
+      # Try "CHECK_INS_URL" then url_for_app("check-ins")
+      return env_overridden_hostname.split("://")[0] if env_overridden_hostname
 
-        app_name = app_name.to_s.gsub("_", "-")
-        case env
-        when "production"
-          "https://#{app_name}.planningcenteronline.com"
-        when "staging"
-          "https://#{app_name}-staging.planningcenteronline.com"
-        when "development"
-          "http://#{app_name}.pco.dev"
-        when "test"
-          "http://#{app_name}.pco.test"
-        end
+      case env
+      when "production", "staging"
+        "https"
+      else
+        "http"
       end
     end
 
+    def hostname
+      # Try "CHECK_INS_URL" then url_for_app("check-ins")
+      return env_overridden_hostname.split("://")[1] if env_overridden_hostname
+
+      case env
+      when "production"
+        "#{@app_name}.planningcenteronline.com"
+      when "staging"
+        "#{@app_name}-staging.planningcenteronline.com"
+      when "development"
+        "#{@app_name}.pco.dev"
+      when "test"
+        "#{@app_name}.pco.test"
+      end
+    end
+
+    def uri
+      query = @query ? "?#{@query}" : nil
+      url_string = "#{scheme}://#{hostname}/#{@path}#{query}".sub(/(\/)+$/,'')
+      URI(url_string)
+    end
+
+    def to_s
+      uri.to_s
+    end
+
+    private
+
+    def env
+      ENV["DEPLOY_ENV"] || Rails.env
+    end
+
+    def env_overridden_hostname
+      env_var = @app_name.to_s.upcase + "_URL"
+      ENV[env_var]
+    end
   end
+
+  class InvalidPCOURLString < StandardError; end
 end

data/pco-url.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = PCO::URL::VERSION
   spec.authors       = ["James Miller"]
   spec.email         = ["bensie@gmail.com"]
-  spec.summary       = %q{Generate URLs for app PCO apps in all environments}
+  spec.summary       = %q{Generate URLs for PCO apps in all environments}
   spec.homepage      = "https://github.com/ministrycentered/pco-url"
   spec.license       = "MIT"
 
@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "urlcrypt", ">= 0.1.1"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", ">= 3.0.0", "< 4"

data/spec/pco_url_spec.rb

@@ -7,10 +7,15 @@ Applications = [
   :check_ins,
   :people,
   :registrations,
-  :resources
+  :resources,
+  :giving
 ]
 
 describe PCO::URL do
+  before :all do
+    URLcrypt.key = "984e9002e680dc9b9c2556434c47f7e4782191f52063277901e4a009797652e08f28be069dfb4d4a1e3c9ab09fedab59be2c9b6486748bf44030182815ee4987"
+  end
+
   describe "defaults" do
     describe "development" do
       before do
@@ -127,4 +132,83 @@ describe PCO::URL do
     end
   end
 
+  describe "encrypted params" do
+    subject { PCO::URL.new(app_name: "people", query: "foo=bar", encrypt_query_params: true) }
+
+    it "encrypts URL parameters" do
+      expect(subject.query).to_not eq("foo=bar")
+    end
+
+    it 'puts the encrypted params into the _e key' do
+      expect(subject.query).to match(/^_e=(.*)/)
+    end
+
+    it "encrypts and decrypts URL parameters" do
+      expect(URLcrypt.decrypt(subject.query.gsub("_e=", ""))).to eq("foo=bar")
+    end
+
+    it "decrypts using #decrypt_query_params" do
+      expect(PCO::URL.decrypt_query_params(subject.query.gsub("_e=", ""))).to eq("foo=bar")
+    end
+  end
+
+  describe '.parse' do
+    subject { PCO::URL.parse("https://people-staging.planningcenteronline.com") }
+
+    it 'returns a PCO::URL object' do
+      expect(subject.class).to eq(PCO::URL)
+    end
+
+    context 'when only a url string is passed' do
+      subject { PCO::URL.parse("http://people.pco.dev") }
+
+      it 'sets the app_name attr' do
+        expect(subject.app_name).to eq('people')
+      end
+
+      it 'strips -staging if supplied' do
+        expect(PCO::URL.parse("https://people-staging.plannincenteronline.com").app_name).
+          to eq('people')
+      end
+    end
+
+    context 'when a string and path is passed' do
+      subject { PCO::URL.parse("https://people.planningcenteronline.com/households/2.json") }
+
+      it 'sets the app_name and path attrs' do
+        expect(subject.app_name).to eq('people')
+        expect(subject.path).to eq('/households/2.json')
+      end
+    end
+
+    context 'when a string, path and query are passed' do
+      let(:pco_url) { PCO::URL.new(app_name: :people, path: 'households/2.html', query: 'full_access=1&total_control=1', encrypt_query_params: true) }
+
+      subject { PCO::URL.parse("https://people.planningcenteronline.com/households/2.html?full_access=1&total_control=1") }
+
+      it 'sets the app_name, path, and query attrs' do
+        expect(subject.app_name).to eq('people')
+        expect(subject.path).to eq('/households/2.html')
+        expect(subject.query).to eq('full_access=1&total_control=1')
+      end
+
+      context 'when the query is encrypted' do
+        subject { PCO::URL.parse(pco_url.to_s) }
+
+        it 'first decrypts the query' do
+          expect(pco_url.query).not_to eq('full_access=1&total_control=1')
+          expect(subject.query).to eq('full_access=1&total_control=1')
+        end
+      end
+
+      context "when part of the query string is encrypted" do
+        subject { PCO::URL.parse(pco_url.to_s + "&foo=bar") }
+
+        it "decrypts the encrypted portion and appends the unencrypted portion" do
+          expect(subject.query).to eq('full_access=1&total_control=1&foo=bar')
+        end
+      end
+    end
+  end
+
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pco-url
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - James Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: urlcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +84,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- circle.yml
 - lib/pco/url.rb
 - lib/pco/url/version.rb
 - pco-url.gemspec
@@ -95,10 +110,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Generate URLs for app PCO apps in all environments
+summary: Generate URLs for PCO apps in all environments
 test_files:
 - spec/pco_url_spec.rb
 - spec/spec_helper.rb