facebook-interface-charyf 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6354418fdea89ce45541b7d34bcad2b4ac10fa45
+  data.tar.gz: 38a8037775e61640daf099e1ce0315bb8dda9971
+SHA512:
+  metadata.gz: 05cabc6a4585daef038c601d713d3d60c405e0c723074b1fc534675edb35a003e4a29802fad4e7d033eee66521b3caef61d1da79b34923c5e8664af175da92fc
+  data.tar.gz: 5285dd9e3222749a5f91699a6523ff53f559a5301b313dee6ceb6247acef254ce482037af82af038ddfbe63cad3f1047a6ad213242a9f012d30821b98748845e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at richard.ludvigh@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in facebook-charyf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Richard Ludvigh
+
+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,43 @@
+# Facebook::Charyf
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/facebook/charyf`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'facebook-charyf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install facebook-charyf
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/facebook-charyf. 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).
+
+## Code of Conduct
+
+Everyone interacting in the Facebook::Charyf project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/facebook-charyf/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'facebook-interface-charyf'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/facebook-interface-charyf.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "facebook/interface/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "facebook-interface-charyf"
+  spec.version       = Facebook::Interface::VERSION::STRING
+  spec.authors       = ["Richard Ludvigh"]
+  spec.email         = ["richard.ludvigh@gmail.com"]
+
+  spec.summary       = 'Facebook interface for Charyf chatbot framework'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/Charyf/facebook-charyf'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing 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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'charyf', '~> 0.2'
+  spec.add_runtime_dependency 'facebook-messenger'
+  spec.add_runtime_dependency 'rack'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/facebook/interface.rb

@@ -0,0 +1,29 @@
+require 'charyf'
+
+require_relative 'interface/interface'
+
+module Facebook
+  module Interface
+    class Extension < Charyf::Extension
+
+      generators do
+        require_relative 'interface/generators/install/install_generator'
+      end
+
+      configure do
+        config.port = 30000
+        config.host = '0.0.0.0'
+      end
+
+    end
+
+
+    # Provide config on FacebookCharyf module
+    class << self
+      def config
+        Extension.config
+      end
+    end
+
+  end
+end

data/lib/facebook/interface/generators/install/install_generator.rb

@@ -0,0 +1,25 @@
+require 'charyf/utils/generator/base'
+
+module Facebook
+  module Interface
+    module Generators
+      class InstallGenerator < ::Charyf::Generators::Base
+
+        source_root File.expand_path('templates', __dir__)
+
+        def initializer
+          template 'config/initializers/facebook.rb.tt'
+        end
+
+        def finalize
+          return unless behavior == :invoke
+
+          say_status 'notice', "Facebook interface installed" +
+              "\n\t\tDo not forget to enable facebook interface in application configuration" +
+              "\n\t\t\tconfig.enabled_interfaces = [.., :facebook, ..]", :green
+        end
+
+      end
+    end
+  end
+end

data/lib/facebook/interface/generators/install/templates/config/initializers/facebook.rb.tt

@@ -0,0 +1,17 @@
+# It is recommended to set tokens inside environment
+# You need to setup following three tokens
+#
+# ENV['ACCESS_TOKEN'] = 'ACCESS_TOKEN'
+# ENV['APP_SECRET'] = 'APP_SECRET'
+# ENV['VERIFY_TOKEN'] = 'VERIFY_TOKEN'
+
+
+Facebook::Interface::Extension.configure do
+  # Port of the web interface for receiving web hooks
+  #
+  config.port = 30000
+
+  # Host - by default work on all network interfaces
+  #
+  config.host = '0.0.0.0'
+end

data/lib/facebook/interface/interface.rb

@@ -0,0 +1,128 @@
+require 'charyf'
+require 'facebook/messenger'
+
+module Facebook
+  module Interface
+    class Interface < Charyf::Interface::Base
+
+      strategy_name :facebook
+
+      class InvalidConfiguration < StandardError; end
+
+      class << self
+
+        def reply(conversation_id, response)
+          Facebook::Messenger::Bot.deliver({
+                                               recipient: {
+                                                   id: conversation_id
+                                               },
+                                               message: {
+                                                   text: response.text
+                                               },
+                                               message_type: 'RESPONSE'.freeze
+                                           }, access_token: ENV['ACCESS_TOKEN'])
+        end
+
+        def start
+          init unless @initialized
+          return false if @thread && @thread.alive?
+
+          @thread = Thread.new do
+            Rack::Handler::WEBrick.run(
+                Facebook::Messenger::Server,
+                Port: Facebook::Interface.config.port, Host: Facebook::Interface.config.host
+            )
+          end
+          @thread.abort_on_exception = true
+
+          # Currently this call blocks to check if the interface starts
+          sleep 1
+          @thread.join unless @thread.alive?
+        end
+
+        def stop
+          @thread.kill if @thread
+        end
+
+        # If stop does not finish till required timeout
+        # Terminate is called
+        def terminate
+          @thread.terminate if @thread
+        end
+
+        def init
+          validate
+          @initialized = true
+
+          # Facebook::Messenger::Subscriptions.subscribe(access_token: ENV['ACCESS_TOKEN'])
+          # TODO - temporal error with FB platform - old API is not working
+          HTTParty.post 'https://graph.facebook.com/v2.9/me/subscribed_apps', query: { access_token: ENV["ACCESS_TOKEN"] }
+
+
+          Facebook::Messenger::Bot.on :message do |message|
+
+            # message.id          # => 'mid.1457764197618:41d102a3e1ae206a38'
+            # message.sender      # => { 'id' => '1008372609250235' }
+            # message.seq         # => 73
+            # message.sent_at     # => 2016-04-22 21:30:36 +0200
+            # message.text        # => 'Hello, bot!'
+            # message.attachments # => [ { 'type' => 'image', 'payload' => { 'url' => 'https://www.example.com/1.jpg' } } ]
+
+            # message.reply(text: "Hello, i was still not configured to reply to your messages. I will keep responding with this meaningless bullshit " +
+            # "untill you find some time to finally finish me.")
+
+            # TODO errors in this thread are lost :/
+            Thread.new do
+              # Mark the message as seen once bot gets the message
+              message.mark_seen
+
+              sender = message.sender['id']
+              request = Charyf::Engine::Request.new(self, sender, message.id)
+
+              request.text = message.text
+
+              # TODO support more formats
+              unless message.text && !message.text.empty?
+                message.reply(text: 'Only text is supported in this version.')
+              end
+
+              return if repost?(message)
+
+              self.dispatcher.dispatch_async(request)
+            end.abort_on_exception = true
+          end
+
+        end
+
+        def validate
+          unless ENV['ACCESS_TOKEN'] && ENV['APP_SECRET'] && ENV['VERIFY_TOKEN']
+            raise InvalidConfiguration.new("ENV variables are not properly configured. Ensure that ENV['ACCESS_TOKEN'], " +
+                                               "ENV['APP_SECRET'] and ENV['VERIFY_TOKEN'] are set."
+            )
+          end
+        end
+
+        def repost?(message)
+          messages = _storage.get(message.sender['id']) || []
+
+          repost = messages.include? message.id
+
+          messages.push message.id
+
+          if messages.size > 10
+            messages.delete_at(0)
+          end
+
+          _storage.store(message.sender['id'], messages)
+
+          repost
+        end
+
+        def _storage
+          @storage ||= Charyf.application.storage_provider.get_for(self)
+        end
+
+      end
+    end
+  end
+end

data/lib/facebook/interface/version.rb

@@ -0,0 +1,16 @@
+require 'charyf'
+
+module Facebook
+  module Interface
+
+    module VERSION
+      MAJOR = 0
+      MINOR = 3
+      TINY  = 0
+      PRE   = nil
+
+      STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+    end
+
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: facebook-interface-charyf
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Richard Ludvigh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: charyf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: facebook-messenger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Facebook interface for Charyf chatbot framework
+email:
+- richard.ludvigh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- facebook-interface-charyf.gemspec
+- lib/facebook/interface.rb
+- lib/facebook/interface/generators/install/install_generator.rb
+- lib/facebook/interface/generators/install/templates/config/initializers/facebook.rb.tt
+- lib/facebook/interface/interface.rb
+- lib/facebook/interface/version.rb
+homepage: https://github.com/Charyf/facebook-charyf
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Facebook interface for Charyf chatbot framework
+test_files: []