Merge pull request #4 from rubygarage/develop

Merge before first release to add intergrations

Author: sleekybadger

.gitignore

@@ -14,3 +14,5 @@
 .rvmrc
 .ruby-gemset
 .ruby-version
+
+.byebug_history

README.md

@@ -1,41 +1,25 @@
 # Detectify
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/detectify`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Detectify provides a simple way to retrieve an ActiveRecord entity based on the domain/subdomain request information.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'detectify'
-```
-
-And then execute:
+`gem 'detectify', github: 'rubygarage/detectify'`
 
-    $ bundle
+and then execute: `$ bundle`
 
-Or install it yourself as:
-
-    $ gem install detectify
+Finally, restart the server to apply the changes.
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Start off by generating an initializer: `$ bundle exec rails g detectify:install`, this will create file `config/initializers/detectify.rb` in your application directory. You can configure Detectify for your application needs via initializer. After this you can access detected entity via `env['Detectify-Entity']`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/detectify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubygarage/detectify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

detectify.gemspec

@@ -7,16 +7,21 @@ Gem::Specification.new do |spec|
   spec.name          = 'detectify'
   spec.version       = Detectify::VERSION
   spec.authors       = ['Lukyanov Fedor']
-  spec.email         = ['lukyanov.f.ua@gmail.com']
+  spec.email         = ['fedor@rubygarage.org']
 
-  spec.summary       = 'Write a short summary, because Rubygems requires one.'
-  spec.description   = 'Write a longer description or delete this line.'
-  spec.homepage      = 'https://rubygarage.org'
+  spec.summary       = 'Detect ActiveRecord entity via domain or subdomain'
+  spec.description   = 'Detectify provides a simple way to retrieve an ActiveRecord entity' \
+                       'based on the domain/subdomain request information.'
+  spec.homepage      = 'https://github.com/rubygarage/detectify'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'rack', '>= 1.6'
+  spec.add_dependency 'activerecord', '>= 4.2'
+
+  spec.add_development_dependency 'byebug', '~> 9.0'
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

lib/detectify.rb

@@ -1,4 +1,30 @@
 require 'detectify/version'
+require 'detectify/config'
+require 'detectify/query_builder/base'
+require 'detectify/query_builder/sql'
+require 'detectify/detector'
+require 'detectify/middleware'
 
 module Detectify
+  def self.configure
+    yield(config)
+  end
+
+  def self.config
+    @config || reset_config
+  end
+
+  def self.reset_config(config = Config.new)
+    @config = config
+  end
+
+  def self.entity_class
+    if config.entity_class.is_a?(String)
+      Object.const_get(config.entity_class)
+    else
+      config.entity_class
+    end
+  end
 end
+
+require 'detectify/railtie' if defined?(::Rails)

lib/detectify/config.rb

@@ -0,0 +1,14 @@
+module Detectify
+  class Config
+    attr_accessor :entity_class, :tld_length, :ignore_urls,
+                  :domain_column, :subdomain_column
+
+    def initialize
+      @entity_class     = 'Account'
+      @tld_length       = 1
+      @ignore_urls      = []
+      @domain_column    = 'domain'
+      @subdomain_column = 'subdomain'
+    end
+  end
+end

lib/detectify/detector.rb

@@ -0,0 +1,35 @@
+require 'uri'
+
+module Detectify
+  class Detector
+    attr_reader :request_uri
+
+    def initialize(request_url, query_builder = QueryBuilder::SQL)
+      @request_uri   = URI(request_url)
+      @query_builder = query_builder
+    end
+
+    def detect
+      @entity ||= Detectify.entity_class.where(*query).first unless ignore?
+    end
+
+    private
+
+    def ignore?
+      @request_uri.to_s[Regexp.union(*Detectify.config.ignore_urls)]
+    end
+
+    def query
+      @query_builder.new(domain, subdomain).build
+    end
+
+    def domain
+      request_uri.host
+    end
+
+    def subdomain
+      chunks = request_uri.host.split('.')
+      chunks[0...(1 - Detectify.config.tld_length - 2)].join
+    end
+  end
+end

lib/detectify/middleware.rb

@@ -0,0 +1,16 @@
+module Detectify
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request  = Rack::Request.new(env)
+      detector = Detector.new(request.url)
+
+      env['Detectify-Entity'] = detector.detect
+
+      @app.call(env)
+    end
+  end
+end

lib/detectify/query_builder/base.rb

@@ -0,0 +1,26 @@
+module Detectify
+  module QueryBuilder
+    class Base
+      attr_reader :domain, :subdomain
+
+      def initialize(domain, subdomain)
+        @domain    = domain
+        @subdomain = subdomain
+      end
+
+      def build
+        raise(NotImplementedError)
+      end
+
+      private
+
+      def need_domain_clause?
+        Detectify.config.domain_column && domain
+      end
+
+      def need_subdomain_clause?
+        Detectify.config.subdomain_column && subdomain
+      end
+    end
+  end
+end

lib/detectify/query_builder/sql.rb

@@ -0,0 +1,28 @@
+module Detectify
+  module QueryBuilder
+    class SQL < Base
+      def build
+        @query ||= begin
+          query = ["#{domain_clause}#{or_operator}#{subdomain_clause}"]
+          query << domain if need_domain_clause?
+          query << subdomain if need_subdomain_clause?
+          query.compact
+        end
+      end
+
+      private
+
+      def domain_clause
+        "#{Detectify.config.domain_column} = ?" if need_domain_clause?
+      end
+
+      def subdomain_clause
+        "#{Detectify.config.subdomain_column} = ?" if need_subdomain_clause?
+      end
+
+      def or_operator
+        ' OR ' if need_domain_clause? && need_subdomain_clause?
+      end
+    end
+  end
+end

lib/detectify/railtie.rb

@@ -0,0 +1,7 @@
+module Detectify
+  class Railtie < Rails::Railtie
+    initializer 'detectify' do |app|
+      app.config.middleware.use 'Detectify::Middleware'
+    end
+  end
+end