shopqi-app-webhook 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,31 @@
+# ShopQi App Webhook Engine
+
+新增商店用户时向 ShopQi 插入 Webhook 回调记录
+接收从 ShopQi 中发送的 Webhook 事件信息
+
+## 安装
+
+    $ echo "gem 'shopqi-app-webhook'" >> Gemfile
+    $ bundle
+
+## 使用
+
+此 engine 依赖 shopqi-app，使用前需要先调用 shopqi-app 的 generator
+
+    $ rails g shopqi_app client_id client_secret
+    $ rails g shopqi_app_webhook
+
+`client_id`, `client_secret` 在注册 Application 后显示，注册时 `REDIRECT URI` 填写 localhost:3000/callback
+
+## 配置
+
+`app/jobs/webhook_workers.rb` 负责向 ShopQi 创建回调记录
+
+`app/controllers/webhook_controller.rb` 负责接收和处理事件信息
+
+## 启动
+
+    $ rails s
+    $ QUEUE=* bundle exec rake resque:work
+
+访问 [http://localhost:3000](http://localhost:3000)

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ShopQiAppWebhook'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/shopqi_app_webhook/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/shopqi_app_webhook/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/shopqi_app_webhook/application_controller.rb

@@ -0,0 +1,4 @@
+module ShopQiAppWebhook
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/shopqi_app_webhook/webhook_controller.rb

@@ -0,0 +1,36 @@
+module ShopQiAppWebhook
+  class WebhookController < ApplicationController
+    skip_before_filter :verify_authenticity_token
+    skip_before_filter :authenticate_shop!
+    before_filter :check_source # 检查是否来自 ShopQi
+    before_filter :check_shop
+
+    def orders_fulfilled
+      render nothing: true
+    end
+
+    protected
+    def check_source
+      shopqi_sign = request.headers['HTTP_X_SHOPQI_HMAC_SHA256']
+      data = request.body.read
+      request.body.rewind
+      digest  = OpenSSL::Digest::Digest.new('sha256')
+      sign = Base64.encode64(OpenSSL::HMAC.digest(digest, SecretSetting.oauth.secret, data)).strip
+      render json: { errors: 'Signature invalid' } and return unless sign == shopqi_sign
+    end
+
+    def check_shop
+      render json: { errors: 'Domain invalid' } and return unless shop
+    end
+
+    def shop
+      domain = request.headers['HTTP_X_SHOPQI_DOMAIN']
+      @shop ||= Shop.find_by_shopqi_domain(domain) unless domain.blank?
+    end
+
+    def order_id
+      request.headers['HTTP_X_SHOPQI_ORDER_ID']
+    end
+
+  end
+end

data/app/helpers/shopqi_app_webhook/application_helper.rb

@@ -0,0 +1,4 @@
+module ShopQiAppWebhook
+  module ApplicationHelper
+  end
+end

data/app/observers/shopqi_app_webhook/shop_observer.rb

@@ -0,0 +1,9 @@
+module ShopQiAppWebhook
+  class ShopObserver < ActiveRecord::Observer
+    observe :shop
+
+    def after_create(shop)
+      Resque.enqueue(WebhookWorker, shop.id)
+    end
+  end
+end

data/app/views/layouts/shopqi_app_webhook/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ShopQiAppWebhook</title>
+  <%= stylesheet_link_tag    "shopqi_app_webhook/application", :media => "all" %>
+  <%= javascript_include_tag "shopqi_app_webhook/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/lib/generators/shopqi_app_webhook/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Generate ShopQi Webhook Api Files.
+
+Example:
+    rails generate shopqi_app_webhook
+
+    This will create:
+        app/controllers/webhook_controller.rb
+        app/jobs/webhook_workers.rb
+        db/models/order.rb
+        db/migrate/create_orders.rb

data/lib/generators/shopqi_app_webhook/shopqi_app_webhook_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/active_record'
+
+class ShopQiAppWebhookGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  namespace 'shopqi_app_webhook'
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_files
+    directory 'app'
+  end
+
+  def add_routes
+    route "use_shopqi_webhook"
+  end
+
+  def update_files
+    insert_into_file "app/models/shop.rb", "\s\shas_many :orders\n", after: "class Shop < ActiveRecord::Base\n"
+  end
+
+  def install_migration
+    migration_template 'db/migrate/create_orders.rb', 'db/migrate/create_orders.rb'
+  end
+
+  def show
+    readme "README"
+  end
+
+  def self.next_migration_number(dirname)
+    ActiveRecord::Generators::Base.next_migration_number(dirname)
+  end
+end

data/lib/generators/shopqi_app_webhook/templates/README

@@ -0,0 +1,10 @@
+===============================================================================
+
+Step 1.
+  $ bundle exec rake db:create db:migrate
+
+Step 2.
+  $ rails server
+  $ QUEUE=* bundle exec rake resque:work
+
+===============================================================================

data/lib/generators/shopqi_app_webhook/templates/app/controllers/webhook_controller.rb

@@ -0,0 +1,9 @@
+class WebhookController < ShopQiAppWebhook::WebhookController
+
+  def orders_fulfilled
+    attrs = JSON(request.body.read)['order']
+    shop.orders.where(order_id: order_id).first_or_create! name: attrs['name'], order_id: attrs['id'], total_price: attrs['total_price'], created_at: attrs['created_at']
+    render nothing: true
+  end
+
+end

data/lib/generators/shopqi_app_webhook/templates/app/jobs/webhook_worker.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+module WebhookWorker
+
+  @queue = "webhook_worker"
+
+  def self.perform(shop_id)
+    shop = Shop.find(shop_id)
+    Shopkit.setup url: shop.shopqi_domain, access_token: shop.access_token
+    Shopkit.create_webhook event: 'orders/fulfilled', callback_url: "http://#{SecretSetting.domain.host}/webhook"
+  end
+
+end

data/lib/generators/shopqi_app_webhook/templates/app/models/order.rb

@@ -0,0 +1,4 @@
+class Order < ActiveRecord::Base
+  belongs_to :shop
+  attr_accessible :name, :order_id, :total_price, :created_at
+end

data/lib/generators/shopqi_app_webhook/templates/db/migrate/create_orders.rb

@@ -0,0 +1,12 @@
+class CreateOrders < ActiveRecord::Migration
+  def change
+    create_table :orders do |t|
+      t.references :shop    , null: false
+      t.integer :order_id   , unique: true, null: false
+      t.string :name        , limit: 32   , null: false
+      t.float :total_price  , null: false
+      t.datetime :created_at, null: false
+    end
+    add_index :orders, :shop_id, unique: true
+  end
+end

data/lib/shopqi-app-webhook.rb

@@ -0,0 +1,9 @@
+require "shopqi_app_webhook/engine"
+
+module ShopQiAppWebhook
+
+  module Rails
+    autoload :Routes, "shopqi_app_webhook/rails/routes"
+  end
+
+end

data/lib/shopqi_app_webhook/engine.rb

@@ -0,0 +1,25 @@
+module ShopQiAppWebhook
+  class Engine < Rails::Engine
+    isolate_namespace ShopQiAppWebhook
+    engine_name 'shopqi_app_webhook'
+
+    config.active_record.observers = "ShopQiAppWebhook::ShopObserver"
+
+    initializer "shopqi_app_webhook.routes" do
+      ShopQiAppWebhook::Rails::Routes.install
+    end
+
+    initializer "shopqi_app.acronym" do
+      ActiveSupport::Inflector.inflections do |inflect|
+        inflect.acronym 'ShopQi'
+      end
+    end
+
+    initializer "shopqi_app_webhook.resque" do
+      require 'resque/server'
+      current_app_name = ::Rails.application.class.to_s.split("::").first
+      Resque.redis.namespace = "resque:#{current_app_name}"
+    end
+
+  end
+end

data/lib/shopqi_app_webhook/rails/routes.rb

@@ -0,0 +1,15 @@
+module ShopQiAppWebhook
+  module Rails
+    class Routes
+      module Helper
+        def use_shopqi_webhook(options = {}, &block)
+          self.post '/webhook', to: 'webhook#orders_fulfilled'#, format: :json
+        end
+      end
+
+      def self.install
+        ActionDispatch::Routing::Mapper.send :include, ShopQiAppWebhook::Rails::Routes::Helper
+      end
+    end
+  end
+end

data/lib/shopqi_app_webhook/version.rb

@@ -0,0 +1,3 @@
+module ShopQiAppWebhook
+  VERSION = "0.1.0"
+end

data/lib/tasks/shopqi-app-webhook_tasks.rake

@@ -0,0 +1,7 @@
+# desc "Explaining what the task does"
+# task :shopqi-app-webhook do
+#   # Task goes here
+# end
+
+task "resque:setup" => :environment
+require 'resque/tasks'

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: shopqi-app-webhook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- saberma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+- !ruby/object:Gem::Dependency
+  name: shopqi-app
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.1
+- !ruby/object:Gem::Dependency
+  name: resque_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ShopQi app webhook engine.
+email:
+- mahb45@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/helpers/shopqi_app_webhook/application_helper.rb
+- app/controllers/shopqi_app_webhook/application_controller.rb
+- app/controllers/shopqi_app_webhook/webhook_controller.rb
+- app/observers/shopqi_app_webhook/shop_observer.rb
+- app/assets/javascripts/shopqi_app_webhook/application.js
+- app/assets/stylesheets/shopqi_app_webhook/application.css
+- app/views/layouts/shopqi_app_webhook/application.html.erb
+- lib/generators/shopqi_app_webhook/templates/db/migrate/create_orders.rb
+- lib/generators/shopqi_app_webhook/templates/app/jobs/webhook_worker.rb
+- lib/generators/shopqi_app_webhook/templates/app/controllers/webhook_controller.rb
+- lib/generators/shopqi_app_webhook/templates/app/models/order.rb
+- lib/generators/shopqi_app_webhook/templates/README
+- lib/generators/shopqi_app_webhook/shopqi_app_webhook_generator.rb
+- lib/generators/shopqi_app_webhook/USAGE
+- lib/shopqi-app-webhook.rb
+- lib/shopqi_app_webhook/version.rb
+- lib/shopqi_app_webhook/rails/routes.rb
+- lib/shopqi_app_webhook/engine.rb
+- lib/tasks/shopqi-app-webhook_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/saberma/shopqi-app-webhook
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -46102131
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -46102131
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ShopQi app webhook engine.
+test_files: []