detectify 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dde8d3ba42cf907fd5dc86c5c74cfbabb14c1e9d
+  data.tar.gz: bf5dc2515f68b28089473723b5ddef7210da5d97
+SHA512:
+  metadata.gz: b3b09a9900217455213513cc93829d014b55f8285e535d497116624efd751b67c16f322c1be016def079b4bd99ae2f350c9fa02e9972aedd89eff5d26a1c9128
+  data.tar.gz: 60283ffd9598e6226fc5a351d3148baa2408cdbde968af776c4d7872ec860977e3f3f1c4d27edc7eb904db3b22f6e7e889b511e864eaf378f17dd6efb1845abf

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store
+
+.idea
+.rvmrc
+.ruby-gemset
+.ruby-version
+
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at lukyanov.f.ua@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Lukyanov Fedor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Detectify
+
+[![Code Climate](https://codeclimate.com/github/rubygarage/detectify/badges/gpa.svg)](https://codeclimate.com/github/rubygarage/detectify)
+[![Coverage Status](https://coveralls.io/repos/github/rubygarage/detectify/badge.svg?branch=master)](https://coveralls.io/github/rubygarage/detectify?branch=master)
+[![Build Status](https://travis-ci.org/rubygarage/detectify.svg?branch=master)](https://travis-ci.org/rubygarage/detectify)
+
+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:
+
+`gem 'detectify', github: 'rubygarage/detectify'`
+
+and then execute: `$ bundle`
+
+Finally, restart the server to apply the changes.
+
+## Usage
+
+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/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).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/detectify.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'detectify/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'detectify'
+  spec.version = Detectify::VERSION
+  spec.authors = ['Lukyanov Fedor']
+  spec.email   = ['fedor@rubygarage.org']
+
+  spec.license     = 'MIT'
+  spec.homepage    = 'https://github.com/rubygarage/detectify'
+  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.files                 = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 2.2.2'
+
+  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'
+  spec.add_development_dependency 'fuubar', '~> 2.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+end

data/lib/detectify.rb

@@ -0,0 +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)

data/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

data/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

data/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

data/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

data/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

data/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

data/lib/detectify/version.rb

@@ -0,0 +1,3 @@
+module Detectify
+  VERSION = '1.0.3'.freeze
+end

data/lib/generators/detectify/install_generator.rb

@@ -0,0 +1,11 @@
+module Detectify
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer_file
+        copy_file 'detectify.rb', 'config/initializers/detectify.rb'
+      end
+    end
+  end
+end

data/lib/generators/detectify/templates/detectify.rb

@@ -0,0 +1,27 @@
+Detectify.configure do |config|
+  # Set the model that Detectify will use to detect entity.
+  # Default value is 'Account'.
+  # config.entity_class = 'Account'
+
+  # Set the column that will be used to find entity by domain.
+  # If you don't need such lookup, you can simply set
+  # domain_column value as nil. Default value is 'domain'
+  # config.domain_column = 'domain'
+
+  # Set the column that will be used to find entity by subdomain.
+  # If you don't need such lookup, you can simply set
+  # subdomain_column value as nil. Default value is 'subdomain'.
+  # config.subdomain_column = 'subdomain'
+
+  # Set your top level domain length.
+  # For more information about TLD visit http://bit.ly/1jIeoL9
+  # By length, means count of dots in your TLD.
+  # For example, tld_length for 'example.co.uk' domain will be 2,
+  # for 'example.com' will be 1. Default value is 1.
+  # config.tld_length = 1
+
+  # Array of regular expressions, that will be used to determine
+  # whether it is necessary to detect entity. You can add as much as you want,
+  # for example, config.ignore_urls += [%r{/assets/}]. Default values is [].
+  # config.ignore_urls += [%r{/assets/}]
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: detectify
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Lukyanov Fedor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: Detectify provides a simple way to retrieve an ActiveRecord entity based
+  on the domain/subdomain request information.
+email:
+- fedor@rubygarage.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- detectify.gemspec
+- lib/detectify.rb
+- lib/detectify/config.rb
+- lib/detectify/detector.rb
+- lib/detectify/middleware.rb
+- lib/detectify/query_builder/base.rb
+- lib/detectify/query_builder/sql.rb
+- lib/detectify/railtie.rb
+- lib/detectify/version.rb
+- lib/generators/detectify/install_generator.rb
+- lib/generators/detectify/templates/detectify.rb
+homepage: https://github.com/rubygarage/detectify
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Detect ActiveRecord entity via domain or subdomain
+test_files: []