hello-rails 0.0.0 → 0.5.0

data/lib/hello/configuration.rb

@@ -0,0 +1,12 @@
+module Hello
+  # invoked from config/initializers/hello.rb
+  def self.configure
+    yield(configuration)
+  end
+
+  # invoked internally
+  def self.configuration
+    Rails.configuration.hello ||= ActiveSupport::OrderedOptions.new
+  end
+
+end

data/lib/hello/encryptors.rb

@@ -0,0 +1,6 @@
+module Hello
+  module Encryptors
+    autoload :Simple, 'hello/encryptors/simple'
+    autoload :Complex, 'hello/encryptors/complex'
+  end
+end

data/lib/hello/encryptors/complex.rb

@@ -0,0 +1,25 @@
+module Hello
+  module Encryptors
+    class Complex < Simple
+      def initialize(cost=nil)
+        require 'bcrypt'
+        cost ||= Rails.env.test? ? 1 : 10
+        BCrypt::Engine.cost = cost
+      rescue LoadError
+        s = "your Gemfile needs: gem 'bcrypt'"
+        puts [s.red, s.yellow, s.green]
+        raise
+      end
+
+      def encrypt(string)
+        BCrypt::Password.create(string).to_s
+      end
+
+      def match(string, digest)
+        BCrypt::Password.new(digest) == string
+      rescue BCrypt::Errors::InvalidHash
+        false
+      end
+    end
+  end
+end

data/lib/hello/encryptors/simple.rb

@@ -0,0 +1,27 @@
+require 'singleton'
+
+module Hello
+  module Encryptors
+    class Simple
+      include Singleton
+
+      # probability = 1 / ((8*2) ** (8*2))
+      def single(complexity = 8)
+        SecureRandom.hex(complexity)
+      end
+
+      def pair(complexity = 8)
+        s = single(complexity)
+        [s, encrypt(s)]
+      end
+
+      def encrypt(s)
+        Digest::MD5.hexdigest(s)
+      end
+
+      def match(string, token)
+        encrypt(string) == token
+      end
+    end
+  end
+end

data/lib/hello/engine.rb

@@ -0,0 +1,23 @@
+module Hello
+  class Engine < Rails::Engine
+    isolate_namespace Hello
+
+    config.hello = nil
+
+    initializer 'hello.filter' do |app|
+      app.config.filter_parameters += [:password, :token]
+    end
+
+    initializer 'hello.add_middleware' do |app|
+      app.config.app_middleware.use Hello::Middleware
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec, view_specs: false,
+                               controller_specs: false
+      # g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/hello/errors.rb

@@ -0,0 +1,12 @@
+module Hello
+  module Errors
+    class Error < StandardError
+    end
+
+    class JsonNotSupported < Error
+      def message
+        "add your locale as a 'param' or 'header' instead"
+      end
+    end
+  end
+end

data/lib/hello/locales.rb

@@ -0,0 +1,238 @@
+module Hello
+  module Locales
+    ALL = {
+      'af'     => 'Afrikaans',
+      'af-ZA'  => 'Afrikaans (South Africa)',
+      'ar'     => 'Arabic',
+      'ar-AE'  => 'Arabic (U.A.E.)',
+      'ar-BH'  => 'Arabic (Bahrain)',
+      'ar-DZ'  => 'Arabic (Algeria)',
+      'ar-EG'  => 'Arabic (Egypt)',
+      'ar-IQ'  => 'Arabic (Iraq)',
+      'ar-JO'  => 'Arabic (Jordan)',
+      'ar-KW'  => 'Arabic (Kuwait)',
+      'ar-LB'  => 'Arabic (Lebanon)',
+      'ar-LY'  => 'Arabic (Libya)',
+      'ar-MA'  => 'Arabic (Morocco)',
+      'ar-OM'  => 'Arabic (Oman)',
+      'ar-QA'  => 'Arabic (Qatar)',
+      'ar-SA'  => 'Arabic (Saudi Arabia)',
+      'ar-SY'  => 'Arabic (Syria)',
+      'ar-TN'  => 'Arabic (Tunisia)',
+      'ar-YE'  => 'Arabic (Yemen)',
+      'az'     => 'Azeri (Latin)',
+      'az-AZ'  => 'Azeri (Cyrillic) (Azerbaijan)',
+      'be'     => 'Belarusian',
+      'be-BY'  => 'Belarusian (Belarus)',
+      'bg'     => 'Bulgarian',
+      'bg-BG'  => 'Bulgarian (Bulgaria)',
+      'bs-BA'  => 'Bosnian (Bosnia and Herzegovina)',
+      'ca'     => 'Catalan',
+      'ca-ES'  => 'Catalan (Spain)',
+      'cs'     => 'Czech',
+      'cs-CZ'  => 'Czech (Czech Republic)',
+      'cy'     => 'Welsh',
+      'cy-GB'  => 'Welsh (United Kingdom)',
+      'da'     => 'Danish',
+      'da-DK'  => 'Danish (Denmark)',
+      'de'     => 'German',
+      'de-AT'  => 'German (Austria)',
+      'de-CH'  => 'German (Switzerland)',
+      'de-DE'  => 'German (Germany)',
+      'de-LI'  => 'German (Liechtenstein)',
+      'de-LU'  => 'German (Luxembourg)',
+      'dv'     => 'Divehi',
+      'dv-MV'  => 'Divehi (Maldives)',
+      'el'     => 'Greek',
+      'el-GR'  => 'Greek (Greece)',
+      'en'     => 'English',
+      'en-AU'  => 'English (Australia)',
+      'en-BZ'  => 'English (Belize)',
+      'en-CA'  => 'English (Canada)',
+      'en-CB'  => 'English (Caribbean)',
+      'en-GB'  => 'English (United Kingdom)',
+      'en-IE'  => 'English (Ireland)',
+      'en-JM'  => 'English (Jamaica)',
+      'en-NZ'  => 'English (New Zealand)',
+      'en-PH'  => 'English (Republic of the Philippines)',
+      'en-TT'  => 'English (Trinidad and Tobago)',
+      'en-US'  => 'English (United States)',
+      'en-ZA'  => 'English (South Africa)',
+      'en-ZW'  => 'English (Zimbabwe)',
+      'eo'     => 'Esperanto',
+      'es'     => 'Spanish',
+      'es-AR'  => 'Spanish (Argentina)',
+      'es-BO'  => 'Spanish (Bolivia)',
+      'es-CL'  => 'Spanish (Chile)',
+      'es-CO'  => 'Spanish (Colombia)',
+      'es-CR'  => 'Spanish (Costa Rica)',
+      'es-DO'  => 'Spanish (Dominican Republic)',
+      'es-EC'  => 'Spanish (Ecuador)',
+      'es-ES'  => 'Spanish (Spain)',
+      'es-GT'  => 'Spanish (Guatemala)',
+      'es-HN'  => 'Spanish (Honduras)',
+      'es-MX'  => 'Spanish (Mexico)',
+      'es-NI'  => 'Spanish (Nicaragua)',
+      'es-PA'  => 'Spanish (Panama)',
+      'es-PE'  => 'Spanish (Peru)',
+      'es-PR'  => 'Spanish (Puerto Rico)',
+      'es-PY'  => 'Spanish (Paraguay)',
+      'es-SV'  => 'Spanish (El Salvador)',
+      'es-UY'  => 'Spanish (Uruguay)',
+      'es-VE'  => 'Spanish (Venezuela)',
+      'et'     => 'Estonian',
+      'et-EE'  => 'Estonian (Estonia)',
+      'eu'     => 'Basque',
+      'eu-ES'  => 'Basque (Spain)',
+      'fa'     => 'Farsi',
+      'fa-IR'  => 'Farsi (Iran)',
+      'fi'     => 'Finnish',
+      'fi-FI'  => 'Finnish (Finland)',
+      'fo'     => 'Faroese',
+      'fo-FO'  => 'Faroese (Faroe Islands)',
+      'fr'     => 'French',
+      'fr-BE'  => 'French (Belgium)',
+      'fr-CA'  => 'French (Canada)',
+      'fr-CH'  => 'French (Switzerland)',
+      'fr-FR'  => 'French (France)',
+      'fr-LU'  => 'French (Luxembourg)',
+      'fr-MC'  => 'French (Principality of Monaco)',
+      'gl'     => 'Galician',
+      'gl-ES'  => 'Galician (Spain)',
+      'gu'     => 'Gujarati',
+      'gu-IN'  => 'Gujarati (India)',
+      'he'     => 'Hebrew',
+      'he-IL'  => 'Hebrew (Israel)',
+      'hi'     => 'Hindi',
+      'hi-IN'  => 'Hindi (India)',
+      'hr'     => 'Croatian',
+      'hr-BA'  => 'Croatian (Bosnia and Herzegovina)',
+      'hr-HR'  => 'Croatian (Croatia)',
+      'hu'     => 'Hungarian',
+      'hu-HU'  => 'Hungarian (Hungary)',
+      'hy'     => 'Armenian',
+      'hy-AM'  => 'Armenian (Armenia)',
+      'id'     => 'Indonesian',
+      'id-ID'  => 'Indonesian (Indonesia)',
+      'is'     => 'Icelandic',
+      'is-IS'  => 'Icelandic (Iceland)',
+      'it'     => 'Italian',
+      'it-CH'  => 'Italian (Switzerland)',
+      'it-IT'  => 'Italian (Italy)',
+      'ja'     => 'Japanese',
+      'ja-JP'  => 'Japanese (Japan)',
+      'ka'     => 'Georgian',
+      'ka-GE'  => 'Georgian (Georgia)',
+      'kk'     => 'Kazakh',
+      'kk-KZ'  => 'Kazakh (Kazakhstan)',
+      'kn'     => 'Kannada',
+      'kn-IN'  => 'Kannada (India)',
+      'ko'     => 'Korean',
+      'ko-KR'  => 'Korean (Korea)',
+      'kok'    => 'Konkani',
+      'kok-IN' => 'Konkani (India)',
+      'ky'     => 'Kyrgyz',
+      'ky-KG'  => 'Kyrgyz (Kyrgyzstan)',
+      'lt'     => 'Lithuanian',
+      'lt-LT'  => 'Lithuanian (Lithuania)',
+      'lv'     => 'Latvian',
+      'lv-LV'  => 'Latvian (Latvia)',
+      'mi'     => 'Maori',
+      'mi-NZ'  => 'Maori (New Zealand)',
+      'mk'     => 'FYRO Macedonian',
+      'mk-MK'  => 'FYRO Macedonian (Former Yugoslav Republic of Macedonia)',
+      'mn'     => 'Mongolian',
+      'mn-MN'  => 'Mongolian (Mongolia)',
+      'mr'     => 'Marathi',
+      'mr-IN'  => 'Marathi (India)',
+      'ms'     => 'Malay',
+      'ms-BN'  => 'Malay (Brunei Darussalam)',
+      'ms-MY'  => 'Malay (Malaysia)',
+      'mt'     => 'Maltese',
+      'mt-MT'  => 'Maltese (Malta)',
+      'nb'     => 'Norwegian (Bokm?l)',
+      'nb-NO'  => 'Norwegian (Bokm?l) (Norway)',
+      'nl'     => 'Dutch',
+      'nl-BE'  => 'Dutch (Belgium)',
+      'nl-NL'  => 'Dutch (Netherlands)',
+      'nn-NO'  => 'Norwegian (Nynorsk) (Norway)',
+      'ns'     => 'Northern Sotho',
+      'ns-ZA'  => 'Northern Sotho (South Africa)',
+      'pa'     => 'Punjabi',
+      'pa-IN'  => 'Punjabi (India)',
+      'pl'     => 'Polish',
+      'pl-PL'  => 'Polish (Poland)',
+      'ps'     => 'Pashto',
+      'ps-AR'  => 'Pashto (Afghanistan)',
+      'pt'     => 'Portuguese',
+      'pt-BR'  => 'Portuguese (Brazil)',
+      'pt-PT'  => 'Portuguese (Portugal)',
+      'qu'     => 'Quechua',
+      'qu-BO'  => 'Quechua (Bolivia)',
+      'qu-EC'  => 'Quechua (Ecuador)',
+      'qu-PE'  => 'Quechua (Peru)',
+      'ro'     => 'Romanian',
+      'ro-RO'  => 'Romanian (Romania)',
+      'ru'     => 'Russian',
+      'ru-RU'  => 'Russian (Russia)',
+      'sa'     => 'Sanskrit',
+      'sa-IN'  => 'Sanskrit (India)',
+      'se'     => 'Sami (Northern)',
+      'se-FI'  => 'Sami (Northern) (Finland)',
+      'se-NO'  => 'Sami (Northern) (Norway)',
+      'se-SE'  => 'Sami (Lule) (Sweden)',
+      'sk'     => 'Slovak',
+      'sk-SK'  => 'Slovak (Slovakia)',
+      'sl'     => 'Slovenian',
+      'sl-SI'  => 'Slovenian (Slovenia)',
+      'sq'     => 'Albanian',
+      'sq-AL'  => 'Albanian (Albania)',
+      'sr-BA'  => 'Serbian (Latin) (Bosnia and Herzegovina)',
+      'sr-SP'  => 'Serbian (Latin) (Serbia and Montenegro)',
+      'sv'     => 'Swedish',
+      'sv-FI'  => 'Swedish (Finland)',
+      'sv-SE'  => 'Swedish (Sweden)',
+      'sw'     => 'Swahili',
+      'sw-KE'  => 'Swahili (Kenya)',
+      'syr'    => 'Syriac',
+      'syr-SY' => 'Syriac (Syria)',
+      'ta'     => 'Tamil',
+      'ta-IN'  => 'Tamil (India)',
+      'te'     => 'Telugu',
+      'te-IN'  => 'Telugu (India)',
+      'th'     => 'Thai',
+      'th-TH'  => 'Thai (Thailand)',
+      'tl'     => 'Tagalog',
+      'tl-PH'  => 'Tagalog (Philippines)',
+      'tn'     => 'Tswana',
+      'tn-ZA'  => 'Tswana (South Africa)',
+      'tr'     => 'Turkish',
+      'tr-TR'  => 'Turkish (Turkey)',
+      'tt'     => 'Tatar',
+      'tt-RU'  => 'Tatar (Russia)',
+      'ts'     => 'Tsonga',
+      'uk'     => 'Ukrainian',
+      'uk-UA'  => 'Ukrainian (Ukraine)',
+      'ur'     => 'Urdu',
+      'ur-PK'  => 'Urdu (Islamic Republic of Pakistan)',
+      'uz'     => 'Uzbek (Latin)',
+      'uz-UZ'  => 'Uzbek (Cyrillic) (Uzbekistan)',
+      'vi'     => 'Vietnamese',
+      'vi-VN'  => 'Vietnamese (Viet Nam)',
+      'xh'     => 'Xhosa',
+      'xh-ZA'  => 'Xhosa (South Africa)',
+      'zh'     => 'Chinese',
+      'zh-CN'  => 'Chinese (S)',
+      'zh-HK'  => 'Chinese (Hong Kong)',
+      'zh-MO'  => 'Chinese (Macau)',
+      'zh-SG'  => 'Chinese (Singapore)',
+      'zh-TW'  => 'Chinese (T)',
+      'zu'     => 'Zulu',
+      'zu-ZA'  => 'Zulu (South Africa)'
+    }.freeze
+
+    def self.all
+      ALL
+    end
+  end
+end

data/lib/hello/middleware.rb

@@ -0,0 +1,13 @@
+module Hello
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request      = ActionDispatch::Request.new(env)
+      env['hello'] = Hello::RequestManager.create(request)
+      response     = @app.call(env)
+    end
+  end
+end

data/lib/hello/rails_active_record.rb

@@ -0,0 +1,10 @@
+# Cannot be named ActiveRecord or will compete with ::ActiveRecord
+module Hello
+  module RailsActiveRecord
+    autoload :User,               'hello/rails_active_record/user'
+    autoload :Credential,         'hello/rails_active_record/credential'
+    autoload :EmailCredential,    'hello/rails_active_record/email_credential'
+    autoload :PasswordCredential, 'hello/rails_active_record/password_credential'
+    autoload :Access,             'hello/rails_active_record/access'
+  end
+end

data/lib/hello/rails_active_record/access.rb

@@ -0,0 +1,65 @@
+module Hello
+  module RailsActiveRecord
+    class Access < ::ActiveRecord::Base
+      self.table_name = 'accesses'
+
+      # ASSOCIATIONS
+      belongs_to :user, counter_cache: true, class_name: '::User'
+
+      # VALIDATIONS
+      validates_presence_of :user, :expires_at, :user_agent_string, :token
+      validates_uniqueness_of :token
+
+      before_validation on: :create do
+        self.token = "#{user_id}-#{Hello::Encryptors::Simple.instance.single(16)}"
+      end
+
+      # CUSTOM METHODS
+
+      def keep_alive!
+        renew! if expiring?
+      end
+
+      def full_device_name
+        Hello::Utils::DeviceName.instance.parse(user_agent_string)
+      end
+
+      def active_token_or_destroy
+        if expires_at.future?
+          token
+        else
+          destroy && (return nil)
+        end
+      end
+
+      def as_json_web_api
+        as_json.slice(*%w(expires_at token user_id)).merge({ user: user.as_json_web_api })
+      end
+
+      def sudo_expire!
+        update! sudo_expires_at: 1.second.ago
+      end
+
+      private
+
+      def expiring?
+        expires_at < 20.minutes.from_now
+      end
+
+      def renew!
+        update_attributes!(expires_at: 30.minutes.from_now)
+      end
+
+      class << self
+        def destroy_all_expired
+          where('expires_at < ?', Time.now).destroy_all
+          true
+        end
+
+        def cached_destroy_all_expired
+          @@destroy_all_expired ||= destroy_all_expired
+        end
+      end
+    end
+  end
+end

data/lib/hello/rails_active_record/credential.rb

@@ -0,0 +1,51 @@
+module Hello
+  module RailsActiveRecord
+    class Credential < ::ActiveRecord::Base
+      self.table_name = 'credentials'
+
+      # ASSOCIATIONS
+      belongs_to :user, counter_cache: true, class_name: '::User'
+
+      # VALIDATIONS
+      validates_presence_of :user, :type
+      validates_inclusion_of :type, in: %w(EmailCredential PasswordCredential)
+
+      # CUSTOM METHODS
+
+      # def is_email?
+      #   is_a?(EmailCredential)
+      # end
+
+      def first_error_message
+        errors.messages.values.flatten.first if errors.any?
+      end
+
+      # verifying token
+
+      def verifying_token_is?(unencrypted_token)
+        digest = simple_encryptor.encrypt(unencrypted_token)
+        verifying_token_digest == digest
+      end
+
+      def reset_verifying_token!
+        uuid, digest = simple_encryptor.pair
+        update!(verifying_token_digest: digest, verifying_token_digested_at: 1.second.ago)
+        uuid
+      end
+
+      def invalidate_verifying_token!
+        update(verifying_token_digest: nil, verifying_token_digested_at: nil)
+      end
+
+      private
+
+      def hello_is_user_being_destroyed?
+        !!Thread.current['Hello.destroying_user']
+      end
+
+      def simple_encryptor
+        Hello::Encryptors::Simple.instance
+      end
+    end
+  end
+end