facebook_chat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afcdc532ce64d1fa302edb797bf05d81b61695cf
+  data.tar.gz: e93f1dcf5c534f56c0705613967bcfad18584647
+SHA512:
+  metadata.gz: 51b8a9f49ad163d0afaf8635846f351c57a957bfbc2a4fcfb840902f876230305bffb65421a63378462a61985a15279609b158fcff1aac7ba3455a17b903c109
+  data.tar.gz: 5e2d1adbbaf73e673ef3317aec1ffc2d515a03936d0973f76dd8e0d40af872bd9055ac11fa0f7cc2ef5f72ed94328bb08462f4b51769fc8905440e703f9a3847

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in facebook_chat.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kengo Tateishi
+
+MIT License
+
+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,66 @@
+# FacebookChat
+
+FacebookChat is a gem which send a chat message to any facebook friends using Facebook Chat API. It makes you to handle a facebook chat message more easy. If you'd like to know about Facebook Chat API, please check [Facebook Developer's page](https://developers.facebook.com/docs/chat/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'facebook_chat'
+```
+
+And then execute:
+
+```console
+$ bundle install
+```
+
+Or install it yourself as:
+
+```console
+$ gem install facebook_chat
+```
+
+## Usage
+
+### Preparation
+
+Your facebook application should have `xmpp_login` permission to send a chat message. Please set `xmpp_login` permission in your application before go to next step.
+
+### Configuration
+
+First, you have to configure to Facebook Chat API Client.
+
+If you are developing on Rails, you might want to place following code to `config/initializers/facebook_chat.rb`.
+
+```ruby
+require 'facebook_chat'
+
+FacebookChat::Client.configure do |config|
+  config.api_key = '****' # your facebook application's api key
+  config.host = 'chat.facebook.com' # you can omit this line. Default host value is 'chat.facebook.com'
+end
+```
+
+### Send a message
+
+And then, create `FacebookChat::Client` instance and call `send` method.
+
+```ruby
+access_token = '****' # message sender's facebook access token
+cilent = FacebookChat::Client.new(access_token)
+
+to = '1000000000' # facebook user id you want to send a message
+client.send(to, "hey, what's up?")
+```
+
+you can notice that a message is sent to the user who have id `1000000000`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/facebook_chat.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'facebook_chat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "facebook_chat"
+  spec.version       = FacebookChat::VERSION
+  spec.authors       = ["Kengo Tateishi"]
+  spec.email         = ["embrace.ddd.flake.peace@gmail.com"]
+  spec.description   = %q{Facebook Chat API Client}
+  spec.summary       = %q{Facebook Chat API Client}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler", "~> 1.3"
+  spec.add_dependency "rake"
+  spec.add_dependency "xmpp4r"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+end

data/lib/facebook_chat.rb

@@ -0,0 +1,6 @@
+require 'facebook_chat/version'
+require 'facebook_chat/client'
+require 'facebook_chat/x_facebook_platform'
+
+module FacebookChat
+end

data/lib/facebook_chat/client.rb

@@ -0,0 +1,35 @@
+require 'xmpp4r'
+
+module FacebookChat
+  class Client
+    def initialize(access_token)
+      @client = Jabber::Client.new(Jabber::JID.new)
+      @client.connect(FacebookChat::Client.configuration.host)
+      @client.auth_sasl(XFacebookPlatform.new(@client), access_token)
+    end
+
+    def send(id, message)
+      jid = "#{id}@#{FacebookChat::Client.configuration.host}"
+      message = Jabber::Message.new(jid, message)
+      @client.send(message)
+    end
+
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(self.configuration)
+    end
+
+    class Configuration
+      attr_accessor :api_key, :host
+
+      def initialize
+        @api_key = ''
+        @host = 'chat.facebook.com'
+      end
+    end
+  end
+end

data/lib/facebook_chat/version.rb

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

data/lib/facebook_chat/x_facebook_platform.rb

@@ -0,0 +1,50 @@
+require 'cgi'
+
+module FacebookChat
+  class XFacebookPlatform < Jabber::SASL::Base
+    def initialize(stream)
+      super
+
+      challenge = {}
+      error = nil
+      stream.send(generate_auth('X-FACEBOOK-PLATFORM')) do |reply|
+        if reply.name == 'challenge' and reply.namespace == Jabber::SASL::NS_SASL
+          challenge = CGI.parse(Base64::decode64(reply.text))
+        else
+          error = reply.first_element(nil).name
+        end
+        true
+      end
+      raise error if error
+
+      @method = challenge['method'][0]
+      @nonce = challenge['nonce'][0]
+    end
+
+    def auth(access_token)
+      response = {
+        :method => @method,
+        :nonce => @nonce,
+        :access_token => access_token,
+        :api_key => FacebookChat::Client.configuration.api_key,
+        :call_id => Time.now.to_i,
+        :v => '1.0'
+      }
+      response_text = response.collect {|k, v| "#{k}=#{v}" }.join('&')
+
+      response = REXML::Element.new('response')
+      response.add_namespace Jabber::SASL::NS_SASL
+      response.text = Base64::encode64(response_text)
+
+      error = nil
+      @stream.send(response) do |reply|
+        if reply.name != 'success'
+          error = reply.first_element(nil).name
+        end
+        true
+      end
+
+      raise error if error
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'facebook_chat'
+
+describe FacebookChat::Client do
+  let(:api_key) { 'api_key' }
+  let(:host)    { 'example.com' }
+
+  before do
+    FacebookChat::Client.configure do |config|
+      config.api_key = api_key
+      config.host = host
+    end
+  end
+
+  describe 'configuration' do
+    it 'should have correct configuration' do
+      expect(FacebookChat::Client.configuration.api_key).to eq api_key
+      expect(FacebookChat::Client.configuration.host).to eq host
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: facebook_chat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kengo Tateishi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: xmpp4r
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Facebook Chat API Client
+email:
+- embrace.ddd.flake.peace@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- facebook_chat.gemspec
+- lib/facebook_chat.rb
+- lib/facebook_chat/client.rb
+- lib/facebook_chat/version.rb
+- lib/facebook_chat/x_facebook_platform.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Facebook Chat API Client
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb