rs-rails-base 0.1.0

data/docs/chat.md

@@ -0,0 +1,14 @@
+Chat documentation
+======
+
+The chat solution uses Action Cable, for more information please visit: [ActionCable Doc](http://edgeguides.rubyonrails.org/action_cable_overview.html), and to know how to write tests for your solution refer to [ActionCableTesting Gem](https://github.com/palkan/action-cable-testing)
+
+### Chat model diagram
+
+![Chat struct](../images/chat_struct.png "Chat structure")
+
+First you need to register users as participants of a chat, then you can start chatting. The purpose of the participant model is to not only store which user is in each chat, but also store chat common data like "last_message", "last_connection" so queries are on a lightweight table (compared to messages, which is the usual approach).
+
+### Chat flow
+
+![Chat flow](../images/chat_flow.png "Chat flow")

data/docs/facebook.md

@@ -0,0 +1,10 @@
+FACEBOOK DOCUMENTATION
+======
+
+Simple facebook solution is initialized. To learn more about how to work on it please visit: [Koala Doc](https://github.com/arsduo/koala)
+
+### How it works
+
+This is really simple, it just adds a service that wraps all the logic to interact with Facebook, and modifies routes & session to work with new session data.
+
+You can check and test the generated endpoints in apiary!

data/docs/twilio.md

@@ -0,0 +1,21 @@
+SMS & Calls documentations
+======
+
+The call & messaging solution uses Twilio, for more information please visit: [Twilio Doc](https://github.com/twilio/twilio-ruby), and if you are completely new with twilio, you can take a look at [Twilio quickstart](https://www.twilio.com/docs/sms/quickstart/ruby).
+
+### Getting started (SMS)
+
+There are just a few things to be done:
+* Sign up on Twilio
+* Configure ENV vars in project
+  * TWILIO_ACCOUNT_SID
+  * TWILIO_ACCOUNT_TOKEN
+  * TWILIO_PHONE_FROM
+* Start coding your service call
+
+  ```
+  TwilioService.send_text_message(some_user.phone_number, your_awesome_message)
+  ```
+
+### Getting started (Calls)
+This will come soon

data/lib/rs-rails-base/cli_actions.rb

@@ -0,0 +1,16 @@
+require 'commander/import'
+
+module RailsBase
+  # This module provides help to interact with client terminal
+  module CliActions
+    def say_something(message, style = 'BOLD')
+      cli = HighLine.new
+      cli.say("<%= color('#{message}', #{style}) %>")
+    end
+
+    def self.ask_for_something(ask)
+      cli = HighLine.new
+      cli.ask ask
+    end
+  end
+end

data/lib/rs-rails-base/commands.rb

@@ -0,0 +1,81 @@
+require 'fileutils'
+
+module RailsBase
+  # This module provides commands implementation
+  module Commands
+    extend RailsBase::CliActions
+
+    def self.new_project
+      say_something('Getting ready to get an amazing project')
+      answer = RailsBase::CliActions.ask_for_something('What would be the name for project folder?')
+      if Dir.exist?(answer)
+        say_something('Please dont use same project again and again')
+      else
+        final_version = manage_tags
+        RailsBase::GitActions.fetch_from_remote(final_version)
+        clone_project(final_version, RailsBase::REMOTE_URI, answer)
+        remove_git_configuration(answer)
+      end
+      FileUtils.cd("#{Dir.pwd}/#{answer}")
+      say_something('Download complete')
+    end
+
+    def self.add_feature(feature)
+      if feature.nil?
+        display_menu
+      else
+        feature_case(feature)
+      end
+    end
+
+    def self.feature_case(feature)
+      case feature
+      when FEATURE_OPTIONS[:facebook]
+        RailsBase::Features.facebook
+        puts 'Mark is happy'
+      when FEATURE_OPTIONS[:twilio]
+        RailsBase::Features.twilio
+        puts 'now start messaging'
+      when FEATURE_OPTIONS[:chat]
+        RailsBase::Features.chat
+        puts 'now go and start talking'
+      when 'all', 'All'
+        FEATURE_OPTIONS.each do |k, v|
+          puts "Installing #{v}"
+          RailsBase::Features.send(k)
+          puts "Feature #{v} installed"
+        end
+        puts 'All set'
+      else
+        puts 'Please select a valid option'
+      end
+    end
+
+    def self.manage_tags
+      filters = "awk '{print $2}'| cut -d '/' -f 3 | cut -d '^' -f 1 | uniq"
+      tags = "git ls-remote -t #{RailsBase::REMOTE_URI} | #{filters}"
+      reference_tag = RailsBase::API_BASE_VERSION
+      tag_numbers = reference_tag.split('.')
+      major = tag_numbers[0]
+      minor = tag_numbers[1]
+      `#{tags} | grep '#{major}.#{minor}.[0-9]' | tail -n 1 `
+    end
+
+    def self.clone_project(version, uri, to_folder)
+      command = "git clone -b #{version.strip!} --depth 1 #{uri} #{to_folder} &> /dev/null 2>&1"
+      system(command)
+    end
+
+    def self.remove_git_configuration(project_folder)
+      git_config = project_folder + '/.git'
+      FileUtils.rm_rf(git_config)
+    end
+
+    def self.display_menu
+      say_something('FEATURE OPTIONS:')
+      RailsBase::FEATURE_OPTIONS.merge(all: 'All').each_value do |feature|
+        say_something(" #{feature}")
+      end
+    end
+  end
+end

data/lib/rs-rails-base/constants.rb

@@ -0,0 +1,7 @@
+module RailsBase
+  VERSION = '0.1.0'.freeze
+  API_BASE_VERSION = '1.1.0'.freeze
+  REMOTE_URI = 'git://github.com/rootstrap/rails_api_base.git'.freeze
+  FEATURE_OPTIONS = { facebook: 'Facebook', twilio: 'SMS',
+                      chat: 'Chat' }.freeze
+end

data/lib/rs-rails-base/features.rb

@@ -0,0 +1,16 @@
+module RailsBase
+  # This module handle specific functionalities
+  module Features
+    def self.facebook
+      Facebook.install
+    end
+
+    def self.chat
+      Chat.install
+    end
+
+    def self.twilio
+      Twilio.install
+    end
+  end
+end

data/lib/rs-rails-base/features/chat.rb

@@ -0,0 +1,91 @@
+module RailsBase
+  # This module handle specific functionalities
+  module Features
+    class Chat
+      extend RailsBase::FileManipulation
+      extend RailsBase::RailsActions
+      extend RailsBase::CliActions
+      TEMPLATES_PATH = '../templates/chat/'.freeze
+      VIEWS_PATH = 'app/views/api/v1/'.freeze
+
+      def self.install
+        install_gem('action-cable-testing', '0.3.1')
+        migrations("#{TEMPLATES_PATH}migration-models/")
+        create_files(TEMPLATES_PATH)
+        create_jbuilder_files("#{TEMPLATES_PATH}jbuilder/")
+        create_spec_files("#{TEMPLATES_PATH}specs/")
+        inject_into_files(TEMPLATES_PATH)
+        replace_in_files
+      end
+
+      def self.migrations(templates_path)
+        new_migration(templates_path, 'add_chat.rb')
+        new_migration(templates_path, 'add_participant.rb')
+        new_migration(templates_path, 'add_message.rb')
+        run_migrations
+        create_file('app/models/chat.rb', "#{templates_path}chat.rb")
+        create_file('app/models/message.rb', "#{templates_path}message.rb")
+        create_file('app/models/participant.rb', "#{templates_path}participant.rb")
+      end
+
+      def self.create_files(templates_path)
+        create_file('app/channels/application_cable/channel.rb',
+                    "#{templates_path}channel.rb")
+        create_file('app/channels/application_cable/connection.rb',
+                    "#{templates_path}connection.rb")
+        create_file('app/services/chat_service.rb',
+                    "#{templates_path}chat_service.rb")
+        create_file('app/channels/chat_channel.rb',
+                    "#{templates_path}chat_channel.rb")
+        create_file('app/controllers/api/v1/chats_controller.rb',
+                    "#{templates_path}/chats_controller.rb")
+        create_file('app/controllers/api/v1/messages_controller.rb',
+                    "#{templates_path}/messages_controller.rb")
+      end
+
+      def self.create_spec_files(templates_path)
+        create_file('spec/models/chat.rb', "#{templates_path}chat_spec.rb")
+        create_file('spec/models/participant.rb', "#{templates_path}participant_spec.rb")
+        create_file('spec/models/message.rb', "#{templates_path}message_spec.rb")
+        create_file('spec/services/chat_service_spec.rb', "#{templates_path}chat_service_spec.rb")
+        create_file('spec/factories/chat.rb', "#{templates_path}chat_factory.rb")
+        create_file('spec/factories/participant.rb', "#{templates_path}participant_factory.rb")
+        create_file('spec/factories/message.rb', "#{templates_path}message_factory.rb")
+        create_file('spec/channels/chat_channel_spec.rb', "#{templates_path}chat_channel_spec.rb")
+        create_file('spec/channels/connection_spec.rb', "#{templates_path}connection_spec.rb")
+      end
+
+      def self.create_jbuilder_files(templates_path)
+        create_file("#{VIEWS_PATH}chats/index.json.jbuilder",
+                    "#{templates_path}/index.json.jbuilder")
+        create_file("#{VIEWS_PATH}chats/show.json.jbuilder",
+                    "#{templates_path}/show.json.jbuilder")
+        create_file("#{VIEWS_PATH}chats/_info.json.jbuilder",
+                    "#{templates_path}/_info.json.jbuilder")
+        create_file("#{VIEWS_PATH}chats/_message.json.jbuilder",
+                    "#{templates_path}/_message.json.jbuilder")
+        create_file("#{VIEWS_PATH}messages/_info.json.jbuilder",
+                    "#{templates_path}/messages_create_info.json.jbuilder")
+        create_file("#{VIEWS_PATH}messages/create.json.jbuilder",
+                    "#{templates_path}/messages_create.json.jbuilder")
+      end
+
+      def self.inject_into_files(templates_path)
+        inject_into_file('config/routes.rb', ":profile\n        end", "#{templates_path}routes.rb")
+        inject_into_file('config/routes.rb', "    end\n  end", "#{templates_path}routes_2.rb")
+        inject_into_file('app/models/user.rb', "include DeviseTokenAuth::Concerns::User\n",
+                         "#{templates_path}migration-models/user.rb")
+        inject_into_file('app/controllers/api/v1/sessions_controller.rb',
+                         "include Api::Concerns::ActAsApiRequest\n",
+                         "#{templates_path}sessions_controller.rb", true)
+        inject_into_file('spec/rails_helper.rb', "require 'simplecov'",
+                         "#{templates_path}specs/rails_helper.rb")
+      end
+
+      def self.replace_in_files
+        replace_in_file('config/cable.yml', "test:\n  adapter: async",
+                        "test:\n  adapter: test")
+      end
+    end
+  end
+end

data/lib/rs-rails-base/features/facebook.rb

@@ -0,0 +1,41 @@
+module RailsBase
+  # This module handle specific functionalities
+  module Features
+    class Facebook
+      extend RailsBase::FileManipulation
+      extend RailsBase::CliActions
+
+      def self.install
+        templates_path = '../templates/facebook/'
+        inject_files(templates_path)
+        install_gem('koala', '3.0.0')
+        create_file('spec/requests/api/v1/sessions/facebook_spec.rb',
+                    "#{templates_path}facebook_spec.rb")
+        create_file('app/services/facebook_service.rb',
+                    "#{templates_path}facebook_service.rb")
+        append_to_file('apiary.apib', "#{templates_path}apiary.apib")
+        append_to_file('config/locales/en.yml', "#{templates_path}en.yml")
+      end
+
+      def self.inject_files(templates_path)
+        inject_into_file('config/routes.rb', 'resource :user, only: :update do',
+                         "#{templates_path}routes.rb")
+        inject_into_file('app/controllers/api/v1/sessions_controller.rb',
+                         "include Api::Concerns::ActAsApiRequest\n",
+                         "#{templates_path}sessions_controller.rb", true)
+        inject_into_file('app/controllers/api/v1/sessions_controller.rb',
+                         'private',
+                         "#{templates_path}sessions_controller_2.rb")
+        inject_into_file('spec/factories/user.rb',
+                         "number(10) }\n  end",
+                         "#{templates_path}factories_user.rb")
+        inject_into_file('spec/models/user_spec.rb',
+                         "it { should validate_uniqueness_of(:uid).scoped_to(:provider) }\n",
+                         "#{templates_path}user_spec.rb")
+        inject_into_file('spec/routing/sessions_routing_spec.rb',
+                         "sessions#create'\)\n    end",
+                         "#{templates_path}sessions_routing_spec.rb")
+      end
+    end
+  end
+end

data/lib/rs-rails-base/features/twilio.rb

@@ -0,0 +1,18 @@
+module RailsBase
+  # This module handle specific functionalities
+  module Features
+    class Twilio
+      extend RailsBase::FileManipulation
+      extend RailsBase::CliActions
+
+      def self.install
+        templates_path = '../templates/twilio/'
+        install_gem('twilio-ruby', '5.10.5')
+        create_file('app/services/twilio_service.rb',
+                    "#{templates_path}twilio_service.rb")
+        create_file('config/initializers/twilio.rb',
+                    "#{templates_path}twilio.rb")
+      end
+    end
+  end
+end

data/lib/rs-rails-base/file_manipulation.rb

@@ -0,0 +1,55 @@
+require 'commander/import'
+require 'pathname'
+require 'tty-file'
+
+module RailsBase
+  # This module provides help to file manipulation
+  module FileManipulation
+    extend RailsBase::CliActions
+
+    def append_to_file(file_name, from)
+      from_file = File.expand_path("#{__dir__}/#{from}")
+      TTY::File.append_to_file(file_name, read_all_content(from_file))
+    end
+
+    def create_file(file_name, from)
+      from_file = File.expand_path("#{__dir__}/#{from}")
+      TTY::File.create_file(file_name, read_all_content(from_file))
+    end
+
+    def inject_into_file(file_name, after, from, extra_line_flag = false)
+      from_file = File.expand_path("#{__dir__}/#{from}")
+      content = read_all_content(from_file)
+      content += "\n" if extra_line_flag
+      begin
+        TTY::File.inject_into_file(file_name, content, after: "#{after}\n")
+      rescue StandardError => ex
+        say_something('Make sure you are on the root of your project please')
+        puts ex
+      end
+    end
+
+    def replace_in_file(file_name, old_content, new_content)
+      TTY::File.replace_in_file(file_name, old_content, new_content)
+    end
+
+    def read_all_content(file_name)
+      file = File.open(file_name, 'rb')
+      content = file.read
+      file.close
+      content
+    end
+
+    def install_gem(name, version)
+      if File.exist?('Gemfile')
+        unless read_all_content('Gemfile').include? name
+          gem_line = "gem '#{name}', '~> #{version}' \n"
+          TTY::File.append_to_file('Gemfile', gem_line)
+          system('bundle install')
+        end
+      else
+        say_something('Please go to your root folder :)')
+      end
+    end
+  end
+end

data/lib/rs-rails-base/git_actions.rb

@@ -0,0 +1,13 @@
+require 'commander/import'
+require 'pathname'
+
+module RailsBase
+  # This module provides help to interact with git
+  module GitActions
+    extend RailsBase::CliActions
+
+    def self.fetch_from_remote(version)
+      say_something("Fetching api version ... #{version}")
+    end
+  end
+end

data/lib/rs-rails-base/rails_actions.rb

@@ -0,0 +1,27 @@
+module RailsBase
+  # This module provides help to deal with rails migrations
+  module RailsActions
+    extend RailsBase::FileManipulation
+
+    def new_migration(template_path, name)
+      migration = next_migration_number
+      create_file("db/migrate/#{migration}_#{name}",
+                  "#{template_path}#{name}")
+      sleep(0.1)
+    end
+
+    def run_migrations
+      if File.exist?('config/database.yml')
+        `rake db:migrate`
+      else
+        say_something('Please now create a database.yml file and run `rake db:migrate`')
+      end
+    end
+
+    private
+
+    def next_migration_number
+      Time.now.utc.strftime('%Y%m%d%H%M%S%L')
+    end
+  end
+end

data/lib/rs_rails_base.rb

@@ -0,0 +1,10 @@
+require 'rs-rails-base/constants'
+require 'rs-rails-base/cli_actions'
+require 'rs-rails-base/file_manipulation'
+require 'rs-rails-base/git_actions'
+require 'rs-rails-base/rails_actions'
+require 'rs-rails-base/commands'
+require 'rs-rails-base/features'
+require 'rs-rails-base/features/chat'
+require 'rs-rails-base/features/facebook'
+require 'rs-rails-base/features/twilio'