facemock 0.0.1 → 0.0.2

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 ogawa
+
+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,154 @@
+[![Gem Version](https://badge.fury.io/rb/facemock.svg)](http://badge.fury.io/rb/facemock)
+[![Build Status](https://travis-ci.org/ogawatti/facemock.svg?branch=master)](https://travis-ci.org/ogawatti/facemock)
+[![Coverage Status](https://coveralls.io/repos/ogawatti/facemock/badge.png?branch=master)](https://coveralls.io/r/ogawatti/facemock?branch=master)
+[<img src="https://gemnasium.com/ogawatti/facemock.png" />](https://gemnasium.com/ogawatti/facemock)
+[![Code Climate](https://codeclimate.com/github/ogawatti/facemock.png)](https://codeclimate.com/github/ogawatti/facemock)
+
+# Facemock
+
+Facemock is facebook mock application for FbGraph.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'facemock'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install facemock
+
+## Usage
+
+### Mock on/off
+
+for all gem
+
+    require 'facemock'
+
+    FbGraph       #=> FbGraph
+    Facemock.on
+    FbGraph       #=> Facemock::FbGraph
+    Facemock.off
+    FbGraph       #=> FbGraph
+
+for specified gem
+
+    require 'facemock'
+
+    FbGraph       #=> FbGraph
+    Facemock::FbGraph.on
+    FbGraph       #=> Facemock::FbGraph
+    Facemock::FbGraph.off
+    FbGraph       #=> FbGraph
+
+### Test User
+
+    require 'facemock'
+
+    Facemock.on
+    facebook_app_id     = "100000000000000"
+    facebook_app_secret = "facemock_app_secret"
+    app = FbGraph::Application.new(facebook_app_id, secret: facebook_app_secret)
+
+
+    ## Create Test User
+    user = app.test_user!
+    user = app.test_user!( { name: "test user", permissions: "email, read_stream" } )
+    user.name         #=> "test user"
+    user.permissions  #=> [:email, :read_stream]
+
+
+    ## Get Created Test User
+    app.test_users  #=> [#<Facemock::FbGraph::Application::User id: ...>, ...]
+    app.test_users.size  #=> 2
+    test_users.first     #=> User that was created at the last
+    test_users.last      #=> User that was created at the first
+
+    test_users = app.test_users({ limit: 1, after: 1 })
+    test_users.size = 1
+    test_users.first.id  #=> [#<Facemock::FbGraph::Application::User id: ...>, ...]
+
+
+    # Delete Test User
+    app.test_users.size           #=> 2
+    app.test_users.first.destroy
+    app.test_users.size           #=> 1
+    app.test_users.first.destroy
+    app.test_users                #=> []
+
+### User
+
+    require 'facemock'
+
+    Facemock.on
+    facebook_app_id     = "100000000000000"
+    facebook_app_secret = "facemock_app_secret"
+    app  = FbGraph::Application.new(facebook_app_id, secret: facebook_app_secret)
+    user = app.test_user!({name: "face mock", permissions: "email, read_stream"})
+    access_token = user.access_token
+
+    # Get User by Access Token
+    user = FbGraph::User.me(access_token)
+    user.name         #=> "face mock"
+    user.permissions  #=> [:email, :read_stream]
+
+    # Delete permission
+    user.revoke!
+    user.permissions  #=> []
+
+    # Delete User
+    user.destroy
+    FbGraph::User.me(access_token)  #=> nil
+
+### Register Test User by yaml file
+
+    require 'facemock'
+
+    Facemock::FbGraph.on
+    Facemock::Config.load_users("./test_users.yml")
+
+yaml file see belo.
+
+    ---
+    - :app_id: '000000000000001'
+      :app_secret: test_secret_one
+      :users:
+      - :identifier: 100000000000001
+        :name: test user one
+        :email: test_user_one@example.com
+        :password: testpass
+      - :identifier: '100000000000002'
+        :name: test user two
+        :email: test_user_two@example.com
+        :password: testpass
+    - :app_id: '000000000000002'
+      :app_secret: test_secret_two
+      :users:
+      - :identifier: 100000000000003
+        :name: test user three
+        :email: test_user_three@example.com
+        :password: testpass
+
+### Exception
+
+    require 'facemock'
+
+    Facemock.on
+    begin
+      raise FbGraph::Errors::InvalidToken.new "test exception"
+    rescue => e
+      puts "#{e.class} : #{e.message}"  #=> Facemock::FbGraph::Errors::InvalidToken : test exception
+    end
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/facemock.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'facemock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "facemock"
+  spec.version       = Facemock::VERSION
+  spec.authors       = ["ogawatti"]
+  spec.email         = ["ogawattim@gmail.com"]
+  spec.description   = %q{This gem is used to mock the communication part of the facebook graph api.}
+  spec.summary       = %q{This is facebook mock application for fb_graph.}
+  spec.homepage      = "https://github.com/ogawatti/facemock"
+  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 "activerecord", "~> 4.1.4"
+  spec.add_dependency "sqlite3"
+  spec.add_dependency "fb_graph"
+  spec.add_dependency "hashie"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "coveralls"
+end

data/lib/facemock/config/database.rb

@@ -0,0 +1,99 @@
+require 'active_record'
+
+module Facemock
+  module Config
+    class Database
+      ADAPTER = "sqlite3"
+      DB_DIRECTORY = File.expand_path("../../../../db", __FILE__)
+      DEFAULT_DB_NAME = "facemock"
+      TABLE_NAMES = [:applications, :users, :user_rights]
+
+      attr_reader :name
+
+      def initialize(name=nil)
+        @name = (name.nil? || name.empty?) ? DEFAULT_DB_NAME : name
+        connect
+        create_tables
+      end
+
+      def connect
+        ActiveRecord::Base.establish_connection(adapter: ADAPTER, database: filepath)
+        connection = ActiveRecord::Base.connection unless ActiveRecord::Base.connected?
+        ActiveRecord::Migration.verbose = false
+        @state = :connected
+        connection
+      end
+
+      def disconnect!
+        ActiveRecord::Base.connection.disconnect!
+        @state = :disconnected
+      end
+      
+      def connected?
+        @state == :connected
+      end
+
+      def drop
+        disconnect!
+        File.delete(filepath) if File.exist?(filepath)
+      end
+
+      def clear
+        drop_tables
+        create_tables
+      end
+
+      def create_tables
+        if !File.exist?(filepath) || ActiveRecord::Base.connection.tables.empty?
+          TABLE_NAMES.each do |table_name|
+            unless ActiveRecord::Base.connection.table_exists? table_name
+              self.send "create_#{table_name}_table"
+            end
+          end
+        end
+      end
+
+      def drop_tables
+        if File.exist?(filepath) && !ActiveRecord::Base.connection.tables.empty?
+          TABLE_NAMES.each do |table_name|
+            if ActiveRecord::Base.connection.table_exists? table_name
+              ActiveRecord::Migration.drop_table table_name
+            end
+          end
+        end
+      end
+
+      def filepath
+        name ||= @name
+        File.join(DB_DIRECTORY, "#{@name}.#{ADAPTER}")
+      end
+
+      private
+
+      def create_applications_table
+        ActiveRecord::Migration.create_table :applications do |t|
+          t.string  :secret, :null => false
+        end
+      end
+
+      def create_users_table
+        ActiveRecord::Migration.create_table :users do |t|
+          t.string    :name,           :null => false
+          t.string    :email,          :null => false
+          t.string    :password,       :null => false
+          t.boolean   :installed,      :null => false
+          t.string    :access_token,   :null => false
+          t.integer   :application_id
+          t.timestamp :created_at,     :null => false
+        end
+      end
+
+      def create_user_rights_table
+        ActiveRecord::Migration.create_table :user_rights do |t|
+          t.string  :name,    :null => false
+          t.integer :user_id, :null => false
+        end
+      end
+    end
+  end
+end

data/lib/facemock/config.rb

@@ -0,0 +1,92 @@
+require 'yaml'
+require 'hashie'
+require 'facemock/errors'
+require 'facemock/config/database'
+require 'facemock/fb_graph/application'
+
+module Facemock
+  module Config
+    extend self
+
+    def default_database
+      Database.new
+    end
+
+    def database(name=nil)
+      if name.nil? || name.empty?
+        @db = default_database
+      else
+        @db.disconnect! if @db
+        @db = Database.new(name)
+      end
+      @db
+    end
+
+    def reset_database
+      @db = nil
+    end
+
+    def load_users(ymlfile)
+      load_data = YAML.load_file(ymlfile)
+      raise Facemock::Errors::IncorrectDataFormat.new "data is not Array" unless load_data.kind_of?(Array)
+
+      load_data.each do |app_data|
+        data = Hashie::Mash.new(app_data)
+        app_id     = data.app_id
+        app_secret = data.app_secret
+        users      = data.users
+
+        # Validate data format
+        raise Facemock::Errors::IncorrectDataFormat.new "app id is empty"     unless validate_id(app_id)
+        raise Facemock::Errors::IncorrectDataFormat.new "app secret is empty" unless validate_secret(app_secret)
+        raise Facemock::Errors::IncorrectDataFormat.new "users format is incorrect" unless validate_users(users)
+
+        # Create application and user record
+        self.database if @db
+        app = Facemock::FbGraph::Application.new(app_id, secret: app_secret)
+        users.each do |options|
+          app.test_user!(options)
+        end
+      end
+    end
+
+    private
+
+    def validate_id(id)
+      case id
+      when String  then !id.empty?
+      when Integer then id >= 0
+      else false
+      end
+    end
+
+    def validate_secret(app_secret)
+      case app_secret
+      when String then !app_secret.empty?
+      else false
+      end
+    end
+
+    def validate_users(users)
+      case users
+      when Array
+        return false if users.empty?
+        users.each {|user| return false unless validate_user(Hashie::Mash.new(user)) }
+        true
+      else false
+      end
+    end
+
+    def validate_user(user)
+      return false unless validate_id(user.identifier)
+      [:name, :password, :name].each do |key|
+        value = user.send(key)
+        case value
+        when String then return false if value.empty?
+        else return false
+        end
+      end
+      true
+    end
+  end
+end

data/lib/facemock/errors.rb

@@ -0,0 +1,6 @@
+module Facemock
+  module Errors
+    class Error < StandardError; end
+    class IncorrectDataFormat < StandardError; end
+  end
+end

data/lib/facemock/fb_graph/application/test_users.rb

@@ -0,0 +1,36 @@
+require 'facemock/fb_graph/application/user'
+
+module Facemock
+  module FbGraph
+    class Application < ActiveRecord::Base
+      class TestUsers < Array
+        DEFAULT_LIMIT = 50
+        DEFAULT_AFTER = 0
+
+        def initialize(application_id, options={})
+          @limit = limit = (options[:limit] && options[:limit] > 0) ? options[:limit] : DEFAULT_LIMIT
+          @after = after = (options[:after] && options[:after] > 0) ? options[:after] : DEFAULT_AFTER
+          @application_id = application_id
+          st = after
+          ed = after + limit - 1
+          users = User.where(application_id: application_id).sort_by{|u| u.created_at}
+          users = users.reverse[st..ed] || []
+          super(users)
+        end
+
+        def collection
+          self
+        end
+        
+        def next
+          options = { limit: @limit, after: @after + @limit }
+          TestUsers.new(@application_id, options)
+        end
+
+        def select
+          { limit: DEFAULT_LIMIT, after: DEFAULT_AFTER }
+        end
+      end
+    end
+  end
+end

data/lib/facemock/fb_graph/application/user/right.rb

@@ -0,0 +1,14 @@
+require 'active_record'
+
+module Facemock
+  module FbGraph
+    class Application < ActiveRecord::Base
+      class User < ActiveRecord::Base
+        class Right < ActiveRecord::Base
+          self.table_name = "user_rights"
+          belongs_to :user
+        end
+      end
+    end
+  end
+end

data/lib/facemock/fb_graph/application/user.rb

@@ -0,0 +1,68 @@
+require 'active_record'
+require 'hashie'
+require 'facemock/fb_graph/application/user/right'
+
+module Facemock
+  module FbGraph
+    class Application < ActiveRecord::Base
+      class User < ActiveRecord::Base
+        self.table_name = "users"
+        alias_attribute  :identifier, :id
+        has_many :rights, :dependent => :destroy
+        attr_reader :permissions
+
+        def initialize(options={})
+          opts = Hashie::Mash.new(options)
+          identifier   = opts.identifier   || ("10000" + (0..9).to_a.shuffle[0..10].join).to_i
+          name         = opts.name         || rand(36**10).to_s(36)
+          email        = opts.email        || name.gsub(" ", "_") + "@example.com"
+          password     = opts.password     || rand(36**10).to_s(36)
+          installed    = opts.installed    || false
+          access_token = opts.access_token || Digest::SHA512.hexdigest(identifier.to_s)
+          @permissions = []
+
+          super(
+            :name         => name,
+            :email        => email,
+            :password     => password,
+            :installed    => installed,
+            :access_token => access_token
+          )
+          self.id = identifier
+          if opts.permissions
+            build_rights(opts.permissions)
+            set_permissions
+          elsif opts.application_id
+            self.application_id = opts.application_id
+          end
+        end
+
+        def fetch
+          User.find_by_id(self.id)
+        end
+
+        def revoke!
+          self.rights.each{|right| right.destroy}
+          @permissions = []
+        end
+
+        private
+
+        def set_permissions
+          @permissions = self.rights.inject([]) do |simbols, right|
+            simbols << right.name.to_sym
+          end
+          @permissions.uniq!
+        end
+
+        def build_rights(permissions_string)
+          permissions_string.gsub(/\s/, "").split(",").uniq.each do |permission_name|
+            unless self.rights.find{|perm| perm.name == permission_name}
+              self.rights.build(name: permission_name)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/facemock/fb_graph/application.rb

@@ -0,0 +1,44 @@
+require 'active_record'
+require 'hashie'
+require 'facemock/config'
+require 'facemock/fb_graph/application/user'
+require 'facemock/fb_graph/application/test_users'
+
+module Facemock
+  module FbGraph
+    class Application < ActiveRecord::Base
+      alias_attribute  :identifier, :id
+      has_many :users, :dependent => :destroy
+
+      def initialize(identifier, options={})
+        opts = Hashie::Mash.new(options)
+        if (identifier == :app && opts.access_token)
+          identifier = (0..9).to_a.shuffle[0..15].join
+          secret = opts.access_token
+        else
+          identifer = identifier.to_s
+          secret = opts.secret || rand(36**32).to_s(36)
+        end
+        
+        super(secret: secret)
+        self.identifier = identifier
+        save! unless Application.find_by_id_and_secret(identifier, secret)
+      end
+
+      def fetch
+        self
+      end
+
+      def test_user!(options={})
+        user = User.new(options)
+        user.application_id = self.identifier
+        user.save!
+        user
+      end
+
+      def test_users(options={})
+        TestUsers.new(self.identifier, options)
+      end
+    end
+  end
+end

data/lib/facemock/fb_graph/errors.rb

@@ -0,0 +1,11 @@
+require 'facemock/fb_graph/user'
+require 'facemock/fb_graph/errors'
+
+module Facemock
+  module FbGraph
+    module Errors
+      class Error < StandardError; end
+      class InvalidToken < ::FbGraph::InvalidToken; end
+    end
+  end
+end

data/lib/facemock/fb_graph/user.rb

@@ -0,0 +1,14 @@
+require 'facemock/fb_graph/application/user'
+
+module Facemock
+  module FbGraph
+    module User
+      extend self
+
+      def me(access_token)
+        Facemock::Config.database
+        Application::User.find_by_access_token(access_token)
+      end
+    end
+  end
+end

data/lib/facemock/fb_graph.rb

@@ -0,0 +1,36 @@
+require 'fb_graph'
+require 'facemock/config'
+require 'facemock/fb_graph/user'
+require 'facemock/fb_graph/errors'
+require 'facemock/fb_graph/application'
+
+module Facemock
+  module FbGraph
+    extend self
+
+    def on(options={})
+      if ::FbGraph != Facemock::FbGraph
+        Object.const_set(:SourceFbGraph, ::FbGraph)
+        Object.send(:remove_const, :FbGraph) if Object.constants.include?(:FbGraph)
+        Object.const_set(:FbGraph, Facemock::FbGraph)
+      end
+
+      if options[:database_name]
+        Facemock::Config.database(options[:database_name])
+      else
+        Facemock::Config.database
+      end
+      true
+    end
+
+    def off
+      if ::FbGraph == Facemock::FbGraph
+        Object.send(:remove_const, :FbGraph) if Object.constants.include?(:FbGraph)
+        Object.const_set(:FbGraph, ::SourceFbGraph)
+        Object.send(:remove_const, :SourceFbGraph) if Object.constants.include?(:FbGraph)
+      end
+      Facemock::Config.reset_database
+      true
+    end
+  end
+end