floodgate 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d934a5e26e5c75cb0b000f321de8a0ccfc42c010
-  data.tar.gz: 82b0183c0ec1edf9d9703635c2f003e856a65795
+  metadata.gz: 02d0a31c5adc8fc0c05a7adfc8851e847f203534
+  data.tar.gz: 48cd70c1585d07a4ded3756439512ce71b31088c
 SHA512:
-  metadata.gz: da323e40805cee980fac69efa28f8ee1e803c81c55b2d792f0444e17c879aa370325a3e6841c0c8f8c1132faf2b35405920ef421dc962594ed71783be34a8bc7
-  data.tar.gz: 5aa2e49eeefd7c396c3f21d7403c630f222b581e9d61fc20bb50288a715f3f25d45baaa593a3ca5c8478e98a9e33c87d8ab3bdbd7e7e2f5b30bdc898de84a5e1
+  metadata.gz: 5c3a580540a16329b822ca4a99998beeaa44881730fe05a7ffe87233b4946e2625ff41ca516620f5064eead86b2627e7ba773cf85a0b55ce6dfb02a5a03e4623
+  data.tar.gz: 1a97ae00ddeaf916ce97908f3b267f99fdc7a39f2b9b3a4e079d77fbab33128acdbd217efdbf0b4c18623b70b96e6ae4558a99200c772abdb7b3b037b2f2af60

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p353
+2.1.0

data/floodgate.gemspec

@@ -18,6 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'faraday', '~> 0.8.9'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.9.0'
+  spec.add_runtime_dependency 'hashie', '~> 2.0.5'
+
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 2.14'

data/lib/floodgate/client.rb

@@ -1,11 +1,116 @@
-require 'json'
-require 'open-uri'
+require 'faraday'
+require 'faraday_middleware'
+require 'hashie'
 
 module Floodgate
   class Client
-    def self.status(app_id, api_token)
-      # TODO: Handle errors, timeouts, proxies, environments, etc.
-      JSON.parse(open("https://floodgate-api-staging.herokuapp.com/api/v1/apps/#{app_id}/status?api_token=#{api_token}").read)
+    def self.add_ip_address(ip_address)
+      return if ip_address.nil? || ip_address.empty?
+
+      params = { ip_address: { ip_address: ip_address } }
+
+      post('ip_addresses', params)
+    end
+
+    def self.allowed_ip_addresses
+      status.allowed_ip_addresses
+    end
+
+    def self.close
+      params = { app: { filter_traffic: true } }
+
+      put('', params)
+    end
+
+    def self.open
+      params = { app: { filter_traffic: false } }
+
+      put('', params)
+    end
+
+    def self.remove_ip_address(ip_address)
+      return if ip_address.nil? || ip_address.empty?
+
+      params = { ip_address: { ip_address: ip_address } }
+
+      delete('ip_addresses', params)
+    end
+
+    def self.set_redirect_url(redirect_url)
+      params = { app: { redirect_url: redirect_url } }
+
+      put('', params)
+    end
+
+    def self.default_status
+      Hashie::Mash.new(
+        default_status: true,
+        filter_traffic: false,
+        allowed_ip_addresses: [],
+        redirect_url: nil
+      )
+    end
+
+    def self.status
+      begin
+        get('status')
+      rescue Faraday::Error::ClientError => e
+        # TODO: Log
+        default_status
+      end
+    end
+
+    def self.delete(path, params = {})
+      verb_with_params_in_body(:delete, path, params)
+    end
+
+    def self.get(path, params = {})
+      params.merge!(api_token: Config.api_token)
+
+      response = get_connection.get(path, params)
+
+      response.body
+    end
+
+    def self.post(path, params = {})
+      verb_with_params_in_body(:post, path, params)
+    end
+
+    def self.put(path, params = {})
+      verb_with_params_in_body(:put, path, params)
+    end
+
+    def self.verb_with_params_in_body(verb, path, params = {})
+      params.merge!(api_token: Config.api_token)
+
+      response = get_connection.public_send(verb, path) do |request|
+        request.body = params
+      end
+
+      response.body
+    end
+
+    def self.base_url
+      "https://floodgate-api-staging.herokuapp.com/api/v1/apps/#{Config.app_id}"
+    end
+
+    def self.user_agent
+      'FloodgateAgent'
+    end
+
+    def self.get_connection
+      conn = Faraday.new(url: base_url) do |builder|
+        builder.use Faraday::Response::Mashify
+        builder.use FaradayMiddleware::ParseJson, content_type: 'application/json'
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Response::RaiseError
+        builder.use Faraday::Adapter::NetHttp
+      end
+
+      conn.headers[:user_agent] = user_agent
+
+      conn
     end
   end
 end
+

data/lib/floodgate/config.rb

@@ -1,17 +1,20 @@
 module Floodgate
   class Config
+    class << self
+      attr_accessor :app_id, :api_token
+
+      def reset
+        @app_id = @api_token = nil
+      end
+    end
+
     attr_accessor \
       :allowed_ip_addresses,
-      :api_token,
-      :app_id,
       :filter_traffic,
       :redirect_url
 
-    def initialize(app_id, api_token)
-      @app_id = app_id
-      @api_token = api_token
-
-      json = Client.status(app_id, api_token)
+    def initialize
+      json = Client.status
 
       @filter_traffic = json['filter_traffic']
       @redirect_url = json['redirect_url']
@@ -35,5 +38,10 @@ module Floodgate
     def redirect?
       !redirect_url.nil? && !redirect_url.empty?
     end
+
+    def reset
+      @redirect_url = nil
+      @filter_traffic = false
+    end
   end
 end

data/lib/floodgate/control.rb

@@ -3,8 +3,11 @@ module Floodgate
     attr_accessor :app, :config
 
     def initialize(app, app_id, api_token)
+      Config.app_id = app_id
+      Config.api_token = api_token
+
       @app = app
-      @config = Config.new(app_id, api_token)
+      @config = Config.new
     end
 
     def call(env)

data/lib/floodgate/railtie.rb

@@ -0,0 +1,13 @@
+require 'floodgate'
+require 'rails'
+
+module Floodgate
+  class Railtie < Rails::Railtie
+    railtie_name :floodgate
+
+    rake_tasks do
+      load 'tasks/floodgate_tasks.rake'
+    end
+  end
+end
+

data/lib/floodgate/version.rb

@@ -1,3 +1,3 @@
 module Floodgate
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

data/lib/floodgate.rb

@@ -3,3 +3,5 @@ require 'floodgate/config'
 require 'floodgate/control'
 require 'floodgate/version'
 
+require 'floodgate/railtie' if defined?(Rails)
+

data/lib/tasks/floodgate_tasks.rake

@@ -0,0 +1,45 @@
+namespace :floodgate do
+  desc 'Display the floodgate status'
+  task :status => :environment do
+    puts Floodgate::Client.status
+  end
+
+  desc 'Close the floodgate'
+  task :close => :environment do
+    Floodgate::Client.close
+  end
+
+  desc 'Open the floodgate'
+  task :open => :environment do
+    Floodgate::Client.open
+  end
+
+  desc 'Set the URL floodgate redirects to when filtering traffic'
+  task :set_redirect_url => :environment do
+    redirect_url = ENV['redirect_url']
+
+    Floodgate::Client.set_redirect_url(redirect_url)
+  end
+
+  namespace :ip_address do
+    desc 'Display a list of allowed IP Addresses'
+    task :all => :environment do
+      puts Floodgate::Client.allowed_ip_addresses
+    end
+
+    desc 'Add an IP Address to allow through the floodgate'
+    task :add => :environment do
+      ip_address = ENV['ip_address']
+
+      Floodgate::Client.add_ip_address(ip_address)
+    end
+
+    desc 'Remove an IP Address from the list allowed through the floodgate'
+    task :remove => :environment do
+      ip_address = ENV['ip_address']
+
+      Floodgate::Client.remove_ip_address(ip_address)
+    end
+  end
+end
+

data/spec/lib/floodgate/client_spec.rb

@@ -2,15 +2,155 @@ require 'spec_helper'
 
 module Floodgate
   describe Client do
-    let(:json) { Client.status(app_id, api_token) }
+    let(:app_id) { '9d2852cff163507330242460c0ca5eec' }
+    let(:api_token) { 'f28b5848e158f96e96168aa37f0002f2' }
+    let(:status) { Client.status }
+
+    before do
+      Config.app_id = app_id
+      Config.api_token = api_token
+    end
+
+    describe '.add_ip_address' do
+      context 'when an ip address is specified' do
+        let(:ip_address) { random_ip_address }
+        let(:params) do
+          { ip_address: { ip_address: ip_address } }
+        end
+
+        after { Client.remove_ip_address(ip_address) }
+
+        it 'adds it to the list of allowed ip addresses' do
+          expect { Client.add_ip_address(ip_address) }.to change { Client.allowed_ip_addresses.include?(ip_address) }.from(false).to(true)
+        end
+      end
+
+      context 'when an ip address is not specified' do
+        context 'and it is nil' do
+          let(:ip_address) { nil }
+
+          it' does not post' do
+            expect(Client).not_to receive(:post)
+
+            Client.add_ip_address(ip_address)
+          end
+        end
+
+        context 'and it is empty' do
+          let(:ip_address) { '' }
+
+          it' does not post' do
+            expect(Client).not_to receive(:post)
+
+            Client.add_ip_address(ip_address)
+          end
+        end
+      end
+    end
+
+    describe '.allowed_ip_addresses' do
+      let(:ip_address) { random_ip_address }
+
+      before { Client.add_ip_address(ip_address) }
+      after { Client.remove_ip_address(ip_address) }
+
+      it 'returns the allowed ip addresses' do
+        expect(Client.allowed_ip_addresses).to include(ip_address)
+      end
+    end
+
+    describe '.close' do
+      before { Client.open }
+
+      it 'changes filter_traffic from false to true' do
+        expect { Client.close }.to change { Client.status.filter_traffic }.from(false).to(true)
+      end
+    end
+
+    describe '.open' do
+      before { Client.close }
+
+      it 'changes filter_traffic from true to false' do
+        expect { Client.open }.to change { Client.status.filter_traffic }.from(true).to(false)
+      end
+    end
+
+    describe '.remove_ip_address' do
+      context 'when an ip address is specified' do
+        let(:ip_address) { random_ip_address }
+        let(:params) do
+          { ip_address: { ip_address: ip_address } }
+        end
+
+        before { Client.add_ip_address(ip_address) }
+
+        it 'removes it from the list of allowed ip addresses' do
+          expect { Client.remove_ip_address(ip_address) }.to change { Client.allowed_ip_addresses.include?(ip_address) }.from(true).to(false)
+        end
+      end
+
+      context 'when an ip address is not specified' do
+        context 'and it is nil' do
+          let(:ip_address) { nil }
+
+          it' does not post' do
+            expect(Client).not_to receive(:post)
+
+            Client.remove_ip_address(ip_address)
+          end
+        end
+
+        context 'and it is empty' do
+          let(:ip_address) { '' }
+
+          it' does not post' do
+            expect(Client).not_to receive(:post)
+
+            Client.remove_ip_address(ip_address)
+          end
+        end
+      end
+    end
+
+    describe '.set_redirect_url' do
+      before { Client.set_redirect_url(initial_redirect_url) }
+
+      context 'when a redirect_url is specified' do
+        let(:initial_redirect_url) { nil }
+        let(:redirect_url) { 'http://example.com' }
+
+        it 'changes the redirect_url' do
+          expect { Client.set_redirect_url(redirect_url) }.to change { Client.status.redirect_url }.from(initial_redirect_url).to(redirect_url)
+        end
+      end
+
+      context 'when nil is specified' do
+        let(:initial_redirect_url) { 'http://example.com' }
+        let(:redirect_url) { nil }
+
+        it 'clears the redirect_url' do
+          expect { Client.set_redirect_url(redirect_url) }.to change { Client.status.redirect_url }
+        end
+      end
+    end
+
+    describe '.default_status' do
+      it 'does not filter traffic' do
+        expect(Client.default_status.filter_traffic).to be_false
+      end
+
+      it 'has a flag indicating that it is the default status' do
+        expect(Client.default_status.default_status).to be_true
+      end
+    end
 
     describe '.status' do
       context 'when the credentials are not valid' do
         let(:app_id) { 'foo' }
         let(:api_token) { 'bar' }
 
-        it 'is an error' do
-          expect { json }.to raise_error(OpenURI::HTTPError)
+        it 'returns the default status' do
+          expect(status).to eq Client.default_status
         end
       end
 
@@ -20,7 +160,7 @@ module Floodgate
           let(:api_token) { 'da2f2d06c102eea0f1971c2c90936ee3' }
 
           it 'filter_traffic is true' do
-            expect(json['filter_traffic']).to be_true
+            expect(status.filter_traffic).to be_true
           end
         end
 
@@ -29,10 +169,11 @@ module Floodgate
           let(:api_token) { '349d2b1ee8ec56eb04b909b1eb9993b0' }
 
           it 'filter_traffic is false' do
-            expect(json['filter_traffic']).to be_false
+            expect(status.filter_traffic).to be_false
           end
         end
       end
     end
   end
 end
+

data/spec/lib/floodgate/config_spec.rb

@@ -2,7 +2,11 @@ require 'spec_helper'
 
 module Floodgate
   describe Config do
-    before { Client.stub(:status).and_return json }
+    before do
+      Client.stub(:status).and_return json
+      Config.app_id = app_id
+      Config.api_token = api_token
+    end
 
     let(:json) do
       {
@@ -18,7 +22,7 @@ module Floodgate
 
     let(:app_id) { 'abc123' }
     let(:api_token) { 'def456' }
-    let(:config) { Config.new(app_id, api_token) }
+    let(:config) { Config.new }
 
     describe '#client_allowed?' do
       context 'when the environment specifies the client address in REMOTE_ADDR' do
@@ -185,6 +189,29 @@ module Floodgate
         end
       end
     end
+
+    describe '.reset' do
+      let(:config) { Config.new }
+      let(:filter_traffic) { true }
+      let(:redirect_url) { 'someurl' }
+
+      it 'sets filter_traffic to nil' do
+        expect{ config.reset }. to change{ config.filter_traffic }.from(true).to(false)
+      end
+
+      it 'sets redirect_url to nil' do
+        expect{ config.reset }. to change{ config.redirect_url }.from('someurl').to(nil)
+      end
+
+      it 'sets api_token to nil' do
+        expect{ Config.reset }. to change{ Config.api_token }.from('def456').to(nil)
+      end
+
+      it 'sets app_id to nil' do
+        expect{ Config.reset }. to change{ Config.app_id }.from('abc123').to(nil)
+      end
+
+    end
   end
 end
 

data/spec/spec_helper.rb

@@ -8,10 +8,7 @@ require 'rspec'
 
 require 'floodgate'
 
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.filter_run focused: true
-  config.alias_example_to :fit, focused: true
-  config.alias_example_to :pit, pending: true
-  config.run_all_when_everything_filtered = true
-end
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.expand_path(File.join(__FILE__, '../support/**/*.rb'))].each { |f| require f }
+

data/spec/support/helpers/ip_address_helpers.rb

@@ -0,0 +1,6 @@
+require 'ipaddr'
+
+def random_ip_address
+  IPAddr.new(rand(2**32), Socket::AF_INET).to_s
+end
+

data/spec/support/rspec.rb

@@ -0,0 +1,7 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run focused: true
+  config.alias_example_to :fit, focused: true
+  config.alias_example_to :pit, pending: true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: floodgate
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Mark McEahern
@@ -9,62 +9,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 description: floodgate helps you control access to your app
@@ -75,9 +117,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
-- .ruby-version
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,11 +129,15 @@ files:
 - lib/floodgate/client.rb
 - lib/floodgate/config.rb
 - lib/floodgate/control.rb
+- lib/floodgate/railtie.rb
 - lib/floodgate/version.rb
+- lib/tasks/floodgate_tasks.rake
 - spec/lib/floodgate/client_spec.rb
 - spec/lib/floodgate/config_spec.rb
 - spec/lib/floodgate/control_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers/ip_address_helpers.rb
+- spec/support/rspec.rb
 homepage: http://github.com/adorableio/floodgate
 licenses:
 - MIT
@@ -102,17 +148,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.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: floodgate helps you control access to your app
@@ -121,3 +167,5 @@ test_files:
 - spec/lib/floodgate/config_spec.rb
 - spec/lib/floodgate/control_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers/ip_address_helpers.rb
+- spec/support/rspec.rb