nativegap 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77ad6cce9642d37cc02fcfbc3fbfe1c328193d5ab08f3ddb31ebdac0093556f0
+  data.tar.gz: 73ea7e3f58805d79587aa58f31600949aa2abb2936f9f98808d1d5a8a29b9679
+SHA512:
+  metadata.gz: 125bc598a87fe1754606e7ab1e190b80f60d80ebe430c7832153e46e0d4a10e632a2a38984fa7dac11ce0f04006cf112351a7805c17fd9015b43b759e396e88b
+  data.tar.gz: 4dd7ebf420e0b29d2bc300f81fcc6a2ea9dc7402b8774d65edc59d17f0940790f724b346437297752cad7e12b9789e38c80e0d0f27965d630957108239d409a9

data/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 3.0.0 - 2018/01/06
+
+* features
+    * streamlined `App` model
+    * parameter based apps
+
+### 2.1.4 - 2018/01/06
+
+* enhancements
+    * cleaning up gem files
+
+### 2.1.3 - 2018/01/02
+
+* enhancements
+    * automatically include helper in controllers
+* bugfixes
+    * fixed overriding `set_nativegap_user` method
+
+### 2.1.2 - 2018/01/02
+
+* bugfixes
+    * fixed overriding `set_nativegap_user` method
+
+### 2.1.1 - 2017/12/28
+
+* bugfixes
+    * fixed `uses_native_apps` method
+
+### 2.1.0 - 2017/12/28
+
+* features
+    * introduced `uses_native_apps` method to ActiveRecord models
+* bugfixes
+    * fixed assets precompilation for native platforms
+
+### 2.0.1 - 2017/12/21
+
+* bugfixes
+    * fixed `undefined method 'set_device_owner' for ApplicationController:Class`
+
+### 2.0.0 - 2017/12/21
+
+* features
+    * made Devise optional
+    * added `owner` association to `App` model
+
+### 1.0.0 - 2017/12/20
+
+* initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jonas Hübotter
+
+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,247 @@
+# NativeGap on Rails
+
+[![Gem Version](https://badge.fury.io/rb/nativegap.svg)](https://badge.fury.io/rb/nativegap) <img src="https://travis-ci.org/NativeGap/nativegap-rails.svg?branch=master" />
+
+Build native apps for all major platforms with NativeGap.
+
+#### Platforms
+
+* Android
+* iOS
+* Universal Windows Platform (Windows 10)
+* Chrome (Extension)
+
+#### How it works ...
+
+1. Create and customize your apps from the [NativeGap dashboard](https://nativegap.com).
+2. Add [NativeGap.js](https://github.com/NativeGap/nativegap.js) to your app in order to track currently used apps and to add some custom styling.
+3. Use this gem to track app usage for your users and to add platform specific assets.
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+   * [Setup](#setup)
+   * [Assets](#assets)
+   * [User associations](#user-associations)
+   * [Apps](#apps)
+      * [Methods](#methods)
+      * [Helpers](#helpers)
+   * [Notifications](#notifications)
+* [Configuration](#configuration)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+   * [Contributors](#contributors)
+   * [Semantic versioning](#semantic-versioning)
+* [License](#license)
+
+---
+
+## Installation
+
+NativeGap on Rails works with Rails 5 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+gem 'nativegap'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nativegap
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'nativegap', github: 'NativeGap/nativegap-rails'
+```
+
+Now run the generator:
+
+    $ rails g nativegap
+
+To wrap things up, migrate the changes into your database:
+
+    $ rails db:migrate
+
+Make also sure to add the following to your app config (`config/application.rb`):
+
+```ruby
+config.action_dispatch.default_headers = {
+   'X-Frame-Options' => 'ALLOWALL'
+}
+```
+
+## Usage
+
+### Setup
+
+While this gem assists you in creating a true cross-platform app, [NativeGap](https://nativegap.com) is still needed to create the actual native code. That's not too big of a deal though, NativeApp can be used entirely for free ([learn more](https://nativegap.com/pricing)) and it has an extensive [documentation](https://nativegap.com/guide).
+
+Getting started with NativeGap:
+
+1. Create a new NativeGap app.
+2. Wait until the platforms processed successfully.
+
+That's it!
+
+**Note:** Native also supports the coexistence of multiple NativeGap apps with only one Rails app as a source.
+
+### Assets
+
+With Native it is fairly simple to add platform specific stylesheets and scripts. In your assets directory you have a new folder for your `javascripts` and `stylesheets` (`app/assets/.../nativegap`). In these two folders you are able to add custom assets for specific platforms including `web` specific assets.
+
+You simple have to add ...
+
+```ruby
+= component 'nativegap/assets'
+```
+
+... to the `head` tag of your layout after your other asset include tags.
+
+### User associations
+
+Define an association in models whose objects are supposed to be associated with NativeGap apps. For example `Admin` in `app/models/admin.rb`.
+
+```ruby
+class Admin < ApplicationRecord
+    nativegap
+end
+```
+
+Next attach an admin record by defining a `set_nativegap_user` method. Let's say our model is named `Admin` and `current_admin` is available at controller level. Just add a method to your `ApplicationController`:
+
+```ruby
+def set_nativegap_user
+    current_admin if current_admin
+end
+```
+
+**Note:** If a `current_user` method is available at controller level this method is not required.
+
+You are now able to get NativeGap apps for a specific user:
+
+```ruby
+a = Admin.first
+
+# All app records of a user
+a.nativegap_apps
+```
+
+### Apps
+
+Native introduces an `App` ActiveRecord model. Every object of an associated user class can have multiple apps.
+
+#### Methods
+
+```ruby
+a = App.first
+
+# Returns associated object. Can return `nil`.
+a.owner
+
+# Returns lowercase string of platform.
+d.platform
+
+# Returns the apps start url. This can be used to differentiate between apps, if you have multiple NativeGap apps with one Rails app as source.
+d.url
+
+# Some timestamps
+d.last_used
+d.created_at
+d.updated_at
+
+
+# Returns ActiveRecord array of apps from a specific platform
+d.android
+d.ios
+d.windows
+d.chrome
+
+# Group apps by `platform`
+d.platforms
+
+# Group apps by `url`
+d.apps
+```
+
+#### Helpers
+
+NativeGap on Rails adds some helpers which are available in your controllers and views:
+
+* `current_app` `App` record related to current session. Returns `nil` when the Rails app is being used normally.
+
+* `current_platform` Lowercase string of current platform. Returns `'web'` when the Rails app is being used normally.
+
+### Notifications
+
+You can enable native notifications on most platforms. To handle notifications NativeGem integrates with [OneSignal](https://onesignal.com). You could use the [NotificationsRails](https://github.com/jonhue/notifications-rails) gem and implement the [notification-pusher-onesignal](https://github.com/jonhue/notifications-rails/tree/master/notification-pusher/notification-pusher-onesignal) component to push notifications to your native applications. [OnSignal](https://github.com/jonhue/onsignal) assists you with managing OneSignal along with a user authentication system.
+
+---
+
+## Configuration
+
+You can configure NativeGap on Rails by passing a block to `configure`. This can be done in `config/initializers/nativegap.rb`:
+
+```ruby
+NativeGap.configure do |config|
+    config.android = true
+end
+```
+
+* `#{platform}` Set to `false` to disable the platform. Takes a boolean. Defaults to `true`.
+
+---
+
+## To Do
+
+[Here](https://github.com/NativeGap/nativegap-rails/projects/1) is the full list of current projects.
+
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/NativeGap/nativegap-rails/issues/new).
+
+---
+
+## Contributing
+
+We hope that you will consider contributing to NativeGap on Rails. Please read this short overview for some information about how to get started:
+
+[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
+
+### Contributors
+
+Give the people some :heart: who are working on this project. See them all at:
+
+https://github.com/NativeGap/nativegap-rails/graphs/contributors
+
+### Semantic Versioning
+
+NativeGap on Rails follows Semantic Versioning 2.0 as defined at http://semver.org.
+
+## License
+
+MIT License
+
+Copyright (c) 2017 Jonas Hübotter
+
+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/app/controllers/concerns/native_gap_controller.rb

@@ -0,0 +1,36 @@
+module NativeGapController
+
+    extend ActiveSupport::Concern
+
+    included do
+        before_action :set_nativegap
+    end
+
+    def set_nativegap_user
+        current_user if current_user
+    end
+
+    private
+
+    def set_nativegap
+        platform = params[:nativegap]
+        if platform && NativeGap.configuration.send(platform)
+            id = cookies[:nativegapAppId]
+            url = request.original_url.split('?').first
+            @app = NativeGap::App.find_by(id: id, platform: platform, url: url) if id && NativeGap::App.where(id: id, platform: platform, url: url).any?
+
+            if @app.nil?
+                @app = NativeGap::App.new
+                @app.platform = platform
+                @app.url = url
+            end
+            @app.owner = set_nativegap_user
+            @app.last_used = Time.now
+            @app.save!
+
+            cookies[:nativegapAppId] = @app.id
+            cookies[:nativegapApp] = url
+        end
+    end
+
+end

data/app/helpers/native_helper.rb

@@ -0,0 +1,15 @@
+module NativeHelper
+
+    def current_app
+        NativeGap::App.find(cookies[:nativegapAppId]) if cookies[:nativegapAppId]
+    end
+
+    def current_platform
+        current_app&.platform || 'web'
+    end
+
+    def set_nativegap_user
+        current_user if current_user
+    end
+
+end

data/app/models/concerns/native_model.rb

@@ -0,0 +1,11 @@
+module NativeModel
+
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+        def nativegap
+            has_many :nativegap_apps, class_name: 'NativeGap::App', as: :owner, dependent: :destroy
+        end
+    end
+
+end

data/app/models/native_gap/app_library.rb

@@ -0,0 +1,14 @@
+class NativeGap::AppLibrary < ApplicationRecord
+
+    self.table_name = 'native_gap_apps'
+
+    belongs_to :owner, polymorphic: true, optional: true
+
+    scope :android, -> { where(platform: 'android') }
+    scope :ios, -> { where(platform: 'ios') }
+    scope :windows, -> { where(platform: 'windows') }
+    scope :chrome, -> { where(platform: 'chrome') }
+    scope :platforms, -> { group_by(&:platform) }
+    scope :apps, -> { group_by(&:url) }
+
+end

data/app/views/mozaic/nativegap/_assets.html.erb

@@ -0,0 +1,2 @@
+<%= stylesheet_link_tag "nativegap/#{current_platform}", media: 'all', 'data-turbolinks-track': 'reload' %>
+<%= javascript_include_tag "nativegap/#{current_platform}", 'data-turbolinks-track': 'reload' %>

data/lib/generators/nativegap_generator.rb

@@ -0,0 +1,56 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class NativegapGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    source_root File.join File.dirname(__FILE__), 'templates'
+    desc 'Install NativeGap'
+
+    def self.next_migration_number dirname
+        if ActiveRecord::Base.timestamped_migrations
+            Time.now.utc.strftime '%Y%m%d%H%M%S'
+        else
+            "%.3d" % ( current_migration_number(dirname) + 1 )
+        end
+    end
+
+    def create_initializer
+        template 'initializer.rb', 'config/initializers/nativegap.rb'
+    end
+
+    def create_app_model
+        migration_template 'apps_migration.rb.erb', 'db/migrate/nativegap_migration.rb', migration_version: migration_version
+        template 'app_model.rb', 'app/models/native_gap/app.rb'
+    end
+
+    def create_assets
+        create_assets_for 'android'
+        create_assets_for 'ios'
+        create_assets_for 'windows'
+        create_assets_for 'chrome'
+        create_assets_for 'web'
+    end
+
+    def show_readme
+        readme 'README.md'
+    end
+
+    private
+
+    def migration_version
+        if Rails.version >= '5.0.0'
+            "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+    end
+
+    def create_assets_for platform
+        @platform = platform
+        template 'application.css.erb', "app/assets/stylesheets/nativegap/#{platform}.css"
+        template 'keep-file', "app/assets/stylesheets/nativegap/#{platform}/.keep"
+        template 'application.js.erb', "app/assets/javascripts/nativegap/#{platform}.js"
+        template 'keep-file', "app/assets/javascripts/nativegap/#{platform}/.keep"
+    end
+
+end

data/lib/generators/templates/README.md

@@ -0,0 +1 @@
+Now run `rails db:migrate` to add NativeGap to your database.

data/lib/generators/templates/app_model.rb

@@ -0,0 +1,2 @@
+class NativeGap::App < NativeGap::AppLibrary
+end

data/lib/generators/templates/application.css.erb

@@ -0,0 +1,6 @@
+/*
+ * Use this file to import your platform specific stylesheets.
+ *
+ *= require_tree ./<%= @platform %>
+ *= require_self
+ */

data/lib/generators/templates/application.js.erb

@@ -0,0 +1,3 @@
+// Use this file to require your platform specific javascript.
+//
+//= require_tree ./<%= @platform %>

data/lib/generators/templates/apps_migration.rb.erb

@@ -0,0 +1,16 @@
+class NativegapMigration < ActiveRecord::Migration<%= migration_version %>
+    def change
+        create_table :native_gap_apps do |t|
+
+            t.references :owner, polymorphic: true, index: true
+
+            t.string :platform, index: true
+            t.string :url, index: true
+
+            t.datetime :last_used
+
+            t.timestamps
+
+        end
+    end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,15 @@
+NativeGap.configure do |config|
+
+    # Specify platforms your app supports.
+    # config.android = true
+    # config.ios = true
+    # config.windows = true
+    # config.chrome = true
+
+    # Specify a stringified url helper to set a start url for each platform.
+    # config.android_url = 'root_url'
+    # config.ios_url = 'root_url'
+    # config.windows_url = 'root_url'
+    # config.chrome_url = 'root_url'
+
+end

data/lib/native_gap/configuration.rb

@@ -0,0 +1,35 @@
+module NativeGap
+
+    class << self
+        attr_accessor :configuration
+    end
+
+    def self.configure
+        self.configuration ||= Configuration.new
+        yield configuration
+    end
+
+    class Configuration
+
+        attr_accessor :android
+        attr_accessor :ios
+        attr_accessor :windows
+        attr_accessor :chrome
+        attr_accessor :android_url
+        attr_accessor :ios_url
+        attr_accessor :windows_url
+        attr_accessor :chrome_url
+
+        def initialize
+            @android = true
+            @ios = true
+            @windows = true
+            @chrome = true
+            @android_url = 'root_url'
+            @ios_url = 'root_url'
+            @windows_url = 'root_url'
+            @chrome_url = 'root_url'
+        end
+
+    end
+end

data/lib/native_gap/engine.rb

@@ -0,0 +1,7 @@
+require 'rails/railtie'
+
+module NativeGap
+    class Engine < ::Rails::Engine
+        # isolate_namespace NativeGap
+    end
+end

data/lib/native_gap/railtie.rb

@@ -0,0 +1,30 @@
+require 'rails/railtie'
+
+module NativeGap
+    class Railtie < Rails::Railtie
+
+        initializer 'nativegap.mozaic' do
+            Mozaic.configure do |config|
+                config.define_component 'nativegap/assets'
+            end
+        end
+
+        initializer 'nativegap.active_record' do
+            ActiveSupport.on_load :active_record do
+                include NativeGapModel
+            end
+        end
+
+        initializer 'nativegap.action_controller' do
+            ActiveSupport.on_load :action_controller do
+                include NativeGapHelper
+                include NativeGapController
+            end
+        end
+
+        initializer 'nativegap.sprockets-rails' do
+            Rails.application.config.assets.precompile += %w( nativegap/android.js nativegap/ios.js nativegap/windows.js nativegap/chrome.js nativegap/web.js nativegap/android.css nativegap/ios.css nativegap/windows.css nativegap/chrome.css nativegap/web.css )
+        end
+
+    end
+end

data/lib/native_gap/version.rb

@@ -0,0 +1,5 @@
+module NativeGap
+
+    VERSION = '3.0.0'
+
+end

data/lib/nativegap.rb

@@ -0,0 +1,10 @@
+require 'native_gap/version'
+
+module NativeGap
+
+    require 'native_gap/configuration'
+
+    require 'native_gap/engine'
+    require 'native_gap/railtie'
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: nativegap
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Jonas Hübotter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mozaic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: Build native apps for all major platforms from your Rails applications.
+email: me@jonhue.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- app/controllers/concerns/native_gap_controller.rb
+- app/helpers/native_helper.rb
+- app/models/concerns/native_model.rb
+- app/models/native_gap/app_library.rb
+- app/views/mozaic/nativegap/_assets.html.erb
+- lib/generators/nativegap_generator.rb
+- lib/generators/templates/README.md
+- lib/generators/templates/app_model.rb
+- lib/generators/templates/application.css.erb
+- lib/generators/templates/application.js.erb
+- lib/generators/templates/apps_migration.rb.erb
+- lib/generators/templates/initializer.rb
+- lib/generators/templates/keep-file
+- lib/native_gap/configuration.rb
+- lib/native_gap/engine.rb
+- lib/native_gap/railtie.rb
+- lib/native_gap/version.rb
+- lib/nativegap.rb
+homepage: https://github.com/NativeGap/nativegap-rails
+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.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Build native apps for all major platforms from your Rails applications
+test_files: []