tele_notify 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbe50097b22b33be87df0e943fd2e9d73299e60a
+  data.tar.gz: 3aa23a75e190c554ed96ad13b12c81d26cbbba12
+SHA512:
+  metadata.gz: 4879a4cdcf1abcd3facfe76fe70f0e17b036ae6c700ab773d17077be1d3e23b56f50977422c6144ea3fdab7b972492eced586ed04d99efa3e85f3f896a688005
+  data.tar.gz: 41bff14abafba193d77e8a5ab0c2a11604e15f3307879a1d448bfc3b9959847b2b25d5dcb81100de4c947e49b99638e56463f92a9fbdab862c24886476d65664

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+*.gem
+.bundle
+nbproject/*
+/Gemfile.lock
+bin

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_votable.gemspec
+gemspec
+
+rails_version = ENV['RAILS_VERSION'] || 'default'
+
+rails = case rails_version
+when 'master'
+  { :github => 'rails/rails'}
+when 'default'
+  '~> 3.2.0'
+else
+  "~> #{rails_version}"
+end
+
+gem 'rails', rails

data/README.markdown

@@ -0,0 +1,123 @@
+# TeleNotify
+
+TeleNotify by [ppati000](http://twitter.com/ppati000) enables your Rails app to send notifications/messages to your users via Telegram's Bot API. Forget email newsletters!
+
+A working demo can be tested [here](http://telenotify.herokuapp.com/). For the source, see the [TeleTest repository](https://github.com/ppati000/TeleTest/)
+
+## Installation
+
+Note: For any news, questions, suggestions or anything else, contact and/or follow me on [Twitter](http://twitter.com/ppati000) or send me a [mail](mailto:ppati000@me.com)
+
+### Prerequisites
+
+Needless to say, you need a Telegram bot account first. To generate a new Telegram bot, message [@botfather](https://telegram.me/botfather) on Telegram. For more information, see the [official guide](https://core.telegram.org/bots#botfather).
+During this process, you will obtain a token which you will need in the following steps.
+
+### Install
+
+Just add the following to your Gemfile.
+
+```ruby
+#Gemfile
+gem 'tele_notify', '~> 0.1'
+```
+
+And follow that up with a ``bundle install``.
+
+### Setup and Database Migrations
+
+TeleNotify uses a telegram_users table to store all users. To
+generate and run the migration just use.
+
+    rails generate tele_notify:migration
+
+This will also generate a config file in ```config/initializers/tele_notify.rb```. Make sure to set your Telegram token and application URLs here. It should look something like this:
+
+```ruby
+#Set your home URL, so Telegram callbacks work
+#For production, just use your URL (e.g. https://myapp.com)
+#You MUST NOT include a trailing slash and it MUST be https!
+#INVALID URLS: e.g. http://myapp.com or https://myapp.com/
+TeleNotify::TelegramUser.configure_home_url("YOUR PRODUCTION URL")
+
+#For development, download ngrok from https://ngrok.com/.
+#Extract it and run "./ngrok http 3000"
+#Then copy the URL you get from the console window.
+#Remember to use the HTTPS URL!
+TeleNotify::TelegramUser.configure_dev_url("YOUR NGROK DEVELOPMENT URL")
+
+#Set your Telegram Bot API token here
+#Don't have your token yet? Create your bot using https://telegram.me/botfather
+TeleNotify::TelegramUser.configure_token("YOUR TOKEN")
+```
+
+Next, add two lines of code to make your ApplicationController look like this:
+
+```ruby
+#app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+
+  #IMPORTANT! THESE TWO LINES MUST COME AFTER protect_from_forgery!
+  skip_before_filter :verify_authenticity_token, :only => :webhook
+  include TeleNotify::Controller
+
+  #other code...
+end
+```
+
+Last but not least, add a callback URL for Telegram in ```config/routes.rb```, which must be the same as your token.
+
+```ruby
+#config/routes.rb
+Rails.application.routes.draw do
+  post '/<your token>' => 'application#webhook'
+end
+```
+
+Now that everything is done, you can finally run ```rake db:migrate```. Congratulations! Yout successfully installed TeleNotify!
+
+## Using TeleNotify
+
+To give users the ability to sign up for your Telegram Notifications, put a link to your telegram bot somewhere in your app. This can be as simple as
+
+```html
+<a href="https://telegram.me/YOUR_BOT_USERNAME">Send us a message to receive Push Notifications via Telegram!"</a>
+```
+
+Any user that sends a message to your bot will be stored in the database with their telegram_id and their first_name.
+
+Send messages to those users like this: (e.g. from some controller in your app)
+
+```ruby
+#in some controller action
+
+#sends message to a user
+TeleNotify::TelegramUser.find(1).send_message("How Obama won the internet: Read more at http://example.com")
+
+#finds a user by his Telegram ID and sends him a message
+TeleNotify::TelegramUser.find_by(telegram_id: 12345678).send_message("Some other notification")
+
+#sends a message to everyone who signed up
+TeleNotify::TelegramUser.send_message_to_all("Check out our new stuff!")
+
+```
+
+## Testing
+
+All testing is currently here: [TeleTest repository](https://github.com/ppati000/TeleTest/)
+
+## Changes
+
+0.1
+
+  * Initial release
+
+## Contributing
+
+  Fork it. Commit your changes. Make a pull request :)
+
+## License
+
+TeleNotify was initially forked from [Acts as votable](https://github.com/ryanto/acts_as_votable) by ryanto. It is released under the [MIT
+License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TeleNotify'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/tele_notify/migration/migration_generator.rb

@@ -0,0 +1,35 @@
+require 'rails/generators/migration'
+
+module TeleNotify
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for votable (votes table)"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/tele_notify_migration.rb'
+      end
+    end
+
+    def copy_initializer
+      copy_file 'tele_notify.rb', 'config/initializers/tele_notify.rb'
+    end
+  end
+end

data/lib/generators/tele_notify/migration/templates/active_record/migration.rb

@@ -0,0 +1,19 @@
+class TeleNotifyMigration < ActiveRecord::Migration
+
+  def self.up
+    create_table :telegram_users do |t|
+      t.integer :telegram_id
+      t.string :first_name
+      t.string :username
+
+      t.timestamps
+    end
+
+    add_index :telegram_users, :telegram_id
+  end
+
+  def self.down
+    drop_table :telegram_users
+  end
+
+end

data/lib/generators/tele_notify/migration/templates/active_record/tele_notify.rb

@@ -0,0 +1,15 @@
+#Set your home URL, so Telegram callbacks work
+#For production, just use your URL (e.g. https://myapp.com)
+#You MUST NOT include a trailing slash and it MUST be https!
+#INVALID URLS: e.g. http://myapp.com or https://myapp.com/
+TeleNotify::TelegramUser.configure_home_url("YOUR PRODUCTION URL")
+
+#For development, download ngrok from https://ngrok.com/.
+#Extract it and run "./ngrok http 3000"
+#Then copy the URL you get from the console window.
+#Remember to use the HTTPS URL!
+TeleNotify::TelegramUser.configure_dev_url("YOUR NGROK DEVELOPMENT URL")
+
+#Set your Telegram Bot API token here
+#Don't have your token yet? Create your bot using https://telegram.me/botfather
+TeleNotify::TelegramUser.configure_token("YOUR TOKEN")

data/lib/tele_notify.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module TeleNotify
+
+  if defined?(ActiveRecord::Base)
+    require 'tele_notify/telegram_user'
+    require 'tele_notify/telegram_controller'
+  end
+
+end

data/lib/tele_notify/engine.rb

@@ -0,0 +1,3 @@
+module TeleNotify
+  class Engine < Rails::Engine; end
+end

data/lib/tele_notify/telegram_controller.rb

@@ -0,0 +1,13 @@
+module TeleNotify
+  module Controller
+    def webhook
+      if params[:message]
+        user = TelegramUser.create( { telegram_id: params[:message][:from][:id], first_name: params[:message][:from][:first_name] } )
+        if user
+          user.send_message("Notifications are now active. To cancel, stop this bot in Telegram.")
+        end
+        render :nothing => true, :status => :ok
+      end
+    end
+  end
+end

data/lib/tele_notify/telegram_user.rb

@@ -0,0 +1,56 @@
+require 'rest-client'
+
+module TeleNotify
+  class TelegramUser < ::ActiveRecord::Base
+
+    validates_presence_of :telegram_id
+    validates_uniqueness_of :telegram_id
+
+    @@next_update_id = 0
+
+    def self.configure_home_url(url)
+      @@home_url = url
+    end
+
+    def self.configure_dev_url(url)
+      @@dev_url = url
+    end
+
+    def self.active_url
+      if Rails.env.production?
+        @@home_url
+      else
+        @@dev_url
+      end
+    end
+
+
+    def self.configure_token(token)
+      if token =~ /^[0-9]+:[\w-]+$/ #hacker proof
+        @@token = token
+        @@url = "https://api.telegram.org/bot" + token + "/"
+        @@callback_url = active_url + "/" + @@token
+        RestClient.post(@@url + "setWebhook", { url: @@callback_url })
+      else
+        raise "Invalid token! Please add a valid Telegram token in config/initializers/tele_notify.rb or see https://github.com/ppati000/tele_notify for further instructions."
+      end
+    end
+
+    def self.send_message_to_all(text)
+      success = true
+      TeleNotify::TelegramUser.all.each do |user|
+        success = false if !user.send_message(text)
+      end
+      success
+    end
+
+
+    def send_message(text)
+      response = JSON.parse(RestClient.post(@@url + "sendMessage", chat_id: self.telegram_id, text: text), { symbolize_names: true })
+      response[:ok]
+    end
+
+
+  end
+
+end

data/lib/tele_notify/version.rb

@@ -0,0 +1,3 @@
+module TeleNotify
+  VERSION = "0.1.1"
+end

data/tele_notify.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tele_notify/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tele_notify"
+  s.version     = TeleNotify::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["ppati000", "Ryan"]
+  s.email       = ["ppati000@me.com"]
+  s.homepage    = "https://github.com/ppati000/tele_notify"
+  s.summary     = "Rails gem to send notifications via Telegram"
+  s.description = "TeleNotify by ppati000 enables your Rails app to send notifications/messages to your users via Telegram's Bot API. Forget email newsletters!
+
+  * See installation instructions, demo app and source on https://github.com/ppati000/tele_notify. *"
+
+  s.rubyforge_project = "acts_as_votable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rest-client", "~> 2.0.0.rc1"
+
+  s.add_development_dependency "sqlite3", '~> 1.3.9'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: tele_notify
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- ppati000
+- Ryan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+description: |-
+  TeleNotify by ppati000 enables your Rails app to send notifications/messages to your users via Telegram's Bot API. Forget email newsletters!
+
+    * See installation instructions, demo app and source on https://github.com/ppati000/tele_notify. *
+email:
+- ppati000@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/generators/tele_notify/migration/migration_generator.rb
+- lib/generators/tele_notify/migration/templates/active_record/migration.rb
+- lib/generators/tele_notify/migration/templates/active_record/tele_notify.rb
+- lib/tele_notify.rb
+- lib/tele_notify/engine.rb
+- lib/tele_notify/telegram_controller.rb
+- lib/tele_notify/telegram_user.rb
+- lib/tele_notify/version.rb
+- tele_notify.gemspec
+homepage: https://github.com/ppati000/tele_notify
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: acts_as_votable
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Rails gem to send notifications via Telegram
+test_files: []