telegram_notifications 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e858008d1ae12f788e2ec3f4fcac5827220ee82
+  data.tar.gz: 8e7a4fee96ef7e564f754eb5fab6cfe270de05a2
+SHA512:
+  metadata.gz: 54e0efa527f37d12322ba6502be7701e4621c534edd481725c4908f73e4ac445bde6f462a10bbd47fc7ff2adaded7eccd002ae913937a68e4a1a1a7dc8fa344f
+  data.tar.gz: 4a6facb1f7f8c6ca1e860521f502581d55fc3c9cae3f70a30e78d9cb80516f97bc6e684dab56b381c66074a34134c87ee0d56544ea98278aa14e6b48c31c8ea5

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+nbproject/*
+bin
+

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 hasanbasher1989@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,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in telegram_notifications.gemspec
+gemspec
+
+rails_version = ENV['RAILS_VERSION'] || 'default'
+
+rails = case rails_version
+when 'master'
+  { :github => 'rails/rails'}
+when 'default'
+  '~> 4.2.5'
+else
+  "~> #{rails_version}"
+end
+
+gem 'rails', rails

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Hasan Basheer
+
+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,41 @@
+# TelegramNotifications
+
+TelegramNotifications enables your Rails app to send notifications/messages to your users via Telegram's Bot API
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'telegram_notifications'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install telegram_notifications
+
+## Usage
+
+TelegramNotifications uses a telegram_users table to store all users. To
+generate and run the migration just use.
+
+    rails generate telegram_notifications:migration
+
+This will also generate a config file in ```config/initializers/telegram_notifications.rb```,model "telegram_user.rb" and "" . 
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hbasheer/telegram_notifications. 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,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/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  post '/kkk' => 'telegram_notifications/subscribe#webhook'
+end

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

@@ -0,0 +1,37 @@
+require 'rails/generators/migration'
+
+module TelegramNotifications
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates files for TelegramNotifications gem"
+
+    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/create_telegram_notifications.rb'
+      end
+    end
+
+    def copy_initializer
+      copy_file 'telegram_notifications.rb', 'config/initializers/telegram_notifications.rb'
+      copy_file 'subscribe_controller.rb', 'app/controllers/subscribe_controller.rb'
+      copy_file 'telegram_user.rb', 'app/models/telegram_user.rb'
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+class TelegramNotificationsMigration < ActiveRecord::Migration
+
+  def self.up
+    create_table :telegram_users do |t|
+      t.integer :telegram_id
+      t.string :first_name
+      t.string :last_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/telegram_notifications/migration/templates/active_record/subscribe_controller.rb

@@ -0,0 +1,11 @@
+class SubscribeController < ApplicationController
+  def webhook
+    if params[:message]
+      user = TelegramUser.create( { telegram_id: params[:message][:from][:id], first_name: params[:message][:from][:first_name],last_name: params[:message][:from][:last_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

data/lib/generators/telegram_notifications/migration/templates/active_record/telegram_notifications.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/
+TelegramNotifications::TelegramUser.configure_production_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!
+TelegramNotifications::TelegramUser.configure_development_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
+TelegramNotifications::TelegramUser.configure_token("YOUR TOKEN")

data/lib/generators/telegram_notifications/migration/templates/active_record/telegram_user.rb

@@ -0,0 +1,49 @@
+class TelegramUser < ActiveRecord::Base
+
+  validates_presence_of :telegram_id
+  validates_uniqueness_of :telegram_id
+
+
+  def self.configure_production_url(url)
+    @production_url = url
+  end
+
+  def self.configure_development_url(url)
+    @devolopment_url = url
+  end
+
+  def self.active_url
+    if Rails.env.production? 
+      @production_url
+    else
+      @devolopment_url
+    end
+  end
+
+
+  def self.configure_token(token)
+    if token =~ /^[0-9]+:[\w-]+$/ 
+      @@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/telegram_notifications.rb "
+    end
+  end
+
+  def self.send_message_to_all(text)
+    success = true
+    TelegramNotifications::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

data/lib/telegram_notifications.rb

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

data/lib/telegram_notifications/engine.rb

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

data/lib/telegram_notifications/telegram_controller.rb

@@ -0,0 +1,13 @@
+module TelegramNotifications
+  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/telegram_notifications/telegram_user.rb

@@ -0,0 +1,54 @@
+module TelegramNotifications
+  class TelegramUser < ::ActiveRecord::Base
+
+    validates_presence_of :telegram_id
+    validates_uniqueness_of :telegram_id
+
+    @@next_update_id = 0
+
+
+    def self.configure_production_url(url)
+    	@production_url = url
+    end
+
+    def self.configure_development_url(url)
+    	@devolopment_url = url
+    end
+
+    def self.active_url
+    	if Rails.env.production? 
+    		@production_url
+    	else
+    		@devolopment_url
+    	end
+    end
+
+
+    def self.configure_token(token)
+      if token =~ /^[0-9]+:[\w-]+$/ 
+        @@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/telegram_notifications.rb "
+      end
+    end
+
+    def self.send_message_to_all(text)
+      success = true
+      TelegramNotifications::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/telegram_notifications/version.rb

@@ -0,0 +1,3 @@
+module TelegramNotifications
+  VERSION = "0.0.1"
+end

data/telegram_notifications.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'telegram_notifications/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "telegram_notifications"
+  spec.version       = TelegramNotifications::VERSION
+  spec.authors       = ["Hasan Basheer"]
+  spec.email         = ["hasanbasher1989@gmail.com"]
+
+  spec.summary       = "Rails gem to send notifications via Telegram"
+  spec.description   = "telegram_notifications enables your Rails app to send notifications/messages to your users via Telegram's Bot API."
+  spec.homepage      = "https://github.com/hbasheer/telegram_notifications"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+   # raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: telegram_notifications
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hasan Basheer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: telegram_notifications enables your Rails app to send notifications/messages
+  to your users via Telegram's Bot API.
+email:
+- hasanbasher1989@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/routes.rb
+- lib/generators/telegram_notifications/migration/migration_generator.rb
+- lib/generators/telegram_notifications/migration/templates/active_record/migration.rb
+- lib/generators/telegram_notifications/migration/templates/active_record/subscribe_controller.rb
+- lib/generators/telegram_notifications/migration/templates/active_record/telegram_notifications.rb
+- lib/generators/telegram_notifications/migration/templates/active_record/telegram_user.rb
+- lib/telegram_notifications.rb
+- lib/telegram_notifications/engine.rb
+- lib/telegram_notifications/telegram_controller.rb
+- lib/telegram_notifications/telegram_user.rb
+- lib/telegram_notifications/version.rb
+- telegram_notifications.gemspec
+homepage: https://github.com/hbasheer/telegram_notifications
+licenses:
+- MIT
+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: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Rails gem to send notifications via Telegram
+test_files: []