ffcrm_endpoint 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmYxNThhZjFmMWNmOTA0ZjI4ZjJkMDdiYjU0NjlkZTczNzhkMTMyZg==
+  data.tar.gz: !binary |-
+    NDg0N2MyZWViZTFiYjMzYmQ2NzQ0NmZkM2FiMWI4MDY0MzEzMTY4Ng==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTExZTc1MmVkODlmYWI2MTQ3YmI0ZWE0MGQxMjk0NmM4YzUyMWQwYzhkNzQw
+    ZGUxNjVlOTAyZWEzMTgyNDU0OTQxOTQ4ODVkNTk2YTQ3MGViOGMwNjQ3ZTNk
+    YmEyYWVhMzZjMGJhMWEzMDZmZDZhZTlmZTkzNjBlMDVhNzgxYTg=
+  data.tar.gz: !binary |-
+    NTcyNDU1N2M3NGY4NzQwMjE5NzIzNzUwNjY4YWE1ZTRlMDI0OWZkMzYwYWIz
+    MDQ1NTA1MDY2YzdiYTA5ZWU3MWE0NDE0ZDNiYWI3OTc2OTdjNDVjZjY3MDQ4
+    Njc2MzI0ODYxMjIwNmViYTViZmQyOGVmNDYxNTcyODU3ODNiNGM=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Steve Kenworthy
+
+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,77 @@
+# FfcrmEndpoint
+
+A plugin that enables Fat Free CRM (http://www.fatfreecrm.com) to receive webhooks.
+
+Many websites allow you to send webhooks whenever actions take place. This plugin provides a framework to quickly write custom classes that consume these webhooks and process the data into Fat Free CRM objects.
+
+It was originally built to consume user submitted forms sent via formstack.com but was turned into a generic solution to support wider varieties of input data.
+
+This plugin is aimed at Fat Free CRM developers who want to quickly integrate incoming requests from other websites / services.
+
+Please note this is *not* yet production ready code.
+
+## Installation
+
+Add ```ffcrm_endpoint``` to your Fat Free CRM application Gemfile and run bundle install.
+
+```gem 'ffcrm_endpoint'```
+
+## How it works / Setup steps
+
+* Create a class called ```MyCustomEndpoint``` in ```/app/services/my_custom_endpoint.rb```
+  * Subclass from FfcrmEndpoint::Endpoint
+  * Define a ```process``` method which will receive the request data.
+  * Define an ```authenticate``` method which should return true if the request is allowed to proceed.
+
+  ```ruby
+  class MyPluginName::MyCustomEndpoint < FfcrmEndpoint::Endpoint
+
+    #
+    # This is where you write code to turn the data into Fat Free CRM objects.
+    # You have access to request and params here
+    def process
+    end
+
+    #
+    # return true only if allowed to proceed.
+    def authenticate
+      params[:token].present? && params[:token] == Setting.my_custom_endpoint[:token]
+    end
+
+  end
+  ```
+
+* Point your browser to http://path.to.ffcrm/endpoints/my_custom_endpoint
+
+That's it!
+
+## Under the hood / More details
+
+Simply by going to the URL ```/endpoints/my_custom_endpoint```, the plugin knows to look for the ```MyCustomEndpoint``` class.
+
+### Keeping things secure
+
+```MyCustomEndpoint``` must be subclassed from ```FfcrmEndpoint::Endpoint``` otherwise it will not be allowed as an action. This is deliberate in order to ensure that arbitary ruby classes cannot be called. Consider for a moment what would happen on the URL ```/endpoints/object``` if this protection wasn't built in!
+
+Also note, that you are responsible for sanitizing your data... just as you would in a normal rails action. Be careful.
+
+### Authentication / Tokens
+
+The ```endpoints``` controller delegates authentication to the custom class. This is to allow you to define your own security. A common practice is to use a token that is shared between your external service and Fat Free CRM. Implementation is left to the developer. Just be sure to define the ```authenticate``` method.
+
+## TODO list
+
+* More tests
+* Consolidate how to pass in data
+
+## Bug Fixes / Contributions
+
+Please open issues in the GitHub issue tracker and use pull requests for new features.
+
+## License
+
+MIT (see LICENSE for more details)
+
+## Author
+
+Steve Kenworthy (steveyken@gmail.com)

data/Rakefile

@@ -0,0 +1,38 @@
+
+#!/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    = 'FfcrmEndpoint'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  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
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/controllers/ffcrm_endpoint/endpoints_controller.rb

@@ -0,0 +1,26 @@
+module FfcrmEndpoint
+
+  class EndpointsController < ActionController::Base
+
+    respond_to :json, :js, :html
+
+    def consume
+
+      if endpoint.authenticate
+        endpoint.process
+        respond_with('', location: nil, status: 201)
+      else
+        respond_with('', location: nil, status: :unauthorized)
+      end
+
+    end
+
+    private
+
+    def endpoint
+      @endpoint ||= FfcrmEndpoint::Endpoint.new(params)
+    end
+
+  end
+
+end

data/app/views/ffcrm_endpoint/endpoints/consume.html.haml

@@ -0,0 +1,4 @@
+- if response.code == "201"
+  Success!
+- else response.code == "401"
+  Authentication failed

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+
+  match 'endpoints/:klass_name', controller: 'ffcrm_endpoint/endpoints', action: 'consume', via: [:get, :post, :put]
+
+end

data/lib/ffcrm_endpoint/endpoint.rb

@@ -0,0 +1,78 @@
+module FfcrmEndpoint
+
+  class EndpointNotDefinedError < StandardError; end
+  class EndpointNoActionError < StandardError; end
+  class EndpointDuplicateError < StandardError; end
+
+  class Endpoint
+
+    attr_accessor :params
+    cattr_accessor :klasses do
+      []
+    end
+
+    def initialize(params)
+      @params = params
+      raise EndpointNoActionError, "No action defined." unless params[:klass_name].present?
+    end
+
+    #
+    # The main function to process the incoming data.
+    # It delegates to the process function in your custom endpoint class.
+    def process
+      klass.new(params).process
+    end
+
+    #
+    # The authentication method is called by the endpoint controller before 'process' is run.
+    # 'process' will only be called if authenticate returns true
+    def authenticate
+      klass.new(params).authenticate == true
+    end
+
+    protected
+
+    #
+    # Configuration is assumed to be in Settings namespaced under the name of the action
+    # If class is MyCustomEndpoint, then configuration should be in Setting[:my_custom_endpoint]
+    # You can override this behaviour in the endpoint subclass if desired
+    def config
+      Setting[klass_name]
+    end
+
+    #
+    # klasses are stored as MyPluginName::MyCustomEndpoint
+    # Return first match on "MyCustomEndpoint"
+    def klass
+      @klass ||= klasses.select{|k| k.to_s.demodulize == klass_name}.compact.first
+      raise EndpointNotDefinedError, "To call /endpoints/#{params[:klass_name]} you must define 'class #{params[:klass_name].classify} < FfcrmEndpoint::Endpoint'" if !@klass.present?
+      @klass
+    end
+
+    #
+    # We derive the name of the endpoint subclass from the action
+    # /endpoints/my_custom_endpoint corresponds to MyCustomEndpoint
+    def klass_name
+      "#{params[:klass_name].classify}"
+    end
+
+    private
+
+    #
+    # Endpoints must be registered (by subclassing) before they can be called.
+    # This ensures actions such as "/endpoints/object" don't result in dangerous calls to the Object class
+    def self.inherited(subclass)
+      # handle name duplicates
+      if (duplicates = klasses.select{ |klass| klass.to_s.demodulize == subclass.to_s.demodulize }).any?
+        raise EndpointDuplicateError, "You cannot have endpoints with the same name: #{duplicates.join(', ')}"
+      else
+        klasses << subclass
+      end
+    end
+
+  end
+
+  # Use this hook to load your endpoint subclasses
+  ActiveSupport.run_load_hooks(:ffcrm_endpoint, self)
+
+end

data/lib/ffcrm_endpoint/engine.rb

@@ -0,0 +1,16 @@
+module FfcrmEndpoint
+  class Engine < ::Rails::Engine
+
+    config.to_prepare do
+       require "ffcrm_endpoint/endpoint"
+    end
+
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+  end
+end

data/lib/ffcrm_endpoint/version.rb

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

data/lib/ffcrm_endpoint.rb

@@ -0,0 +1,4 @@
+require "ffcrm_endpoint/engine"
+
+module FfcrmEndpoint
+end

data/lib/tasks/ffcrm_endpoint_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ffcrm_endpoint do
+#   # Task goes here
+# end

data/spec/controllers/endpoints_controller_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe EndpointsController do
+
+  let(:endpoint) { mock(FfcrmEndpoint::Endpoint) }
+
+  describe "consume" do
+
+    it "should call process when authenticate returns true" do
+      endpoint.should_receive(:process)
+      endpoint.should_receive(:authenticate).and_return(true)
+      controller.stub!(:endpoint).and_return(endpoint)
+      get :consume, klass_name: :my_custom_endpoint, format: :js
+      expect(response.status).to eql(201)
+    end
+
+    it "should not call process when authenticate returns false" do
+      endpoint.should_not_receive(:process)
+      endpoint.should_receive(:authenticate).and_return(false)
+      controller.stub!(:endpoint).and_return(endpoint)
+      get :consume, klass_name: :my_custom_endpoint, format: :js
+      #~ expect(response.status).to eql(401)
+    end
+
+  end
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/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/spec/dummy/app/assets/stylesheets/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/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

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