chatty_crow 1.2.1

data/lib/chatty-crow.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/chatty_crow.rb'

data/lib/chatty_crow.rb

@@ -0,0 +1,119 @@
+require 'rest-client'
+require 'chatty_crow/config'
+require 'chatty_crow/error'
+require 'chatty_crow/response'
+require 'chatty_crow/request'
+require 'chatty_crow/request/android'
+require 'chatty_crow/request/ios'
+require 'chatty_crow/request/jabber'
+require 'chatty_crow/request/mail'
+require 'chatty_crow/request/skype'
+require 'chatty_crow/request/sms'
+require 'chatty_crow/notification_request'
+require 'chatty_crow/contacts_request'
+
+# Load Rails Components
+#
+# * Railitie - load config/chatty_crow.yml settings!
+# * ActionMailer - extension to easy send mails via cc
+if defined?(::Rails) && ::Rails::VERSION::MAJOR >= 3
+  require 'chatty_crow/railtie'
+  require 'chatty_crow/action_mailer_extension'
+end
+
+# ChattyCrow global default module entry point to easy send notifications
+#
+#   # Mail
+#   response = ChattyCrow.send_mail
+#
+#   # Create mail & send by .deliver!
+#   mail = ChattyCrow.create_mail subject: 'test'
+#
+#   # IOS
+#   response = ChattyCrow.send_ios data: 'news'
+#
+#   # Android
+#   response = ChattyCrow.send_android data: 'news', contats: [ 'test1' ]
+#
+#   # Skype
+#   response = ChattyCrow.send_skype data: 'news'
+#
+#   # Jabber
+#   response = ChattyCrow.send_android data: 'news'
+#
+#   # Sms
+#   response = ChattyCrow.send_sms 'news'
+#
+# Or work with contacts
+#
+#   # Get all contacts
+#   response = ChattyCrow.get_contacts
+#
+#   # Add contact
+#   response = ChattyCrow.add_contacts 'test1', 'test2'
+#
+#   # Remove contacts
+#   response = ChattyCrow.remove_contacts 'test1', 'test2'
+module ChattyCrow
+  def self.send_mail(*args)
+    NotificationRequest.send(Request::Mail, *args)
+  end
+
+  def self.create_mail(*args)
+    Request::Mail.new(*args)
+  end
+
+  def self.send_ios(*args)
+    NotificationRequest.send(Request::Ios, *args)
+  end
+
+  def self.send_android(*args)
+    NotificationRequest.send(Request::Android, *args)
+  end
+
+  def self.send_skype(*args)
+    NotificationRequest.send(Request::Skype, *args)
+  end
+
+  def self.send_jabber(*args)
+    NotificationRequest.send(Request::Jabber, *args)
+  end
+
+  def self.send_sms(*args)
+    NotificationRequest.send(Request::Sms, *args)
+  end
+
+  def self.get_contacts(options = {})
+    ContactsRequest.get(options)
+  end
+
+  def self.add_contacts(*args)
+    ContactsRequest.add(*args)
+  end
+
+  def self.remove_contacts(*args)
+    ContactsRequest.remove(*args)
+  end
+
+  # Helper method for wrapping non-array objects
+  # @param object [Object] Something
+  # @return [Array] Array
+  def self.wrap(object)
+    if object.nil?
+      []
+    elsif object.respond_to?(:to_ary)
+      object.to_ary || [object]
+    else
+      [object]
+    end
+  end
+
+  # Helper method for extrat options from array!
+  def self.extract_options!(args)
+    if args.last.is_a?(Hash) && args.last.instance_of?(Hash)
+      args.pop
+    else
+      {}
+    end
+  end
+end

data/lib/chatty_crow/action_mailer_extension.rb

@@ -0,0 +1,31 @@
+module ChattyCrow
+  # Action Mailer Rails Extension to easy use
+  # ChattyCrow without modification actuall code
+  module ActionMailerExtension
+    def self.included(base)
+      base.class_eval do
+        class << self
+          attr_accessor :cc_channel
+        end
+
+        # Instance mail request
+        attr_accessor :cc_mail
+
+        # Override message with chatty crow message
+        def message
+          @cc_mail ||= ChattyCrow::Request::Mail.new(self.class, @_message)
+        end
+      end
+      base.extend(ClassMethods)
+    end
+
+    # Class methods
+    module ClassMethods
+      # Set other than default channel
+      # @param channel [String] Different channel
+      def chatty_crow_channel(channel)
+        self.cc_channel = channel
+      end
+    end
+  end
+end

data/lib/chatty_crow/config.rb

@@ -0,0 +1,64 @@
+require 'yaml'
+
+# Configuration module
+module ChattyCrow
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure_from_yaml(path)
+    yaml = YAML.load_file(path)[Rails.env]
+    return unless yaml
+    configuration.host            = yaml['host']
+    configuration.token           = yaml['token']
+    configuration.default_channel = yaml['default_channel']
+  end
+
+  def self.configure_from_rails
+    path = ::Rails.root.join('config', 'chatty_crow.yml')
+    configure_from_yaml(path) if File.exist?(path)
+  end
+
+  def self.default_headers(channel, token)
+    {
+      'Token'   => token   || configuration.token,
+      'Channel' => channel || configuration.default_channel,
+      'Accept'  => 'application/json'
+    }
+  end
+
+  # Configuration class
+  class Configuration
+    # Server settings
+    # Default https://chatty-crow.com (https for secure connection)
+    attr_accessor :host
+
+    # User and channel settings
+    attr_accessor :token, :default_channel
+
+    # Open and read timeouts
+    attr_accessor :http_open_timeout
+    attr_accessor :http_read_timeout
+
+    # Call urls
+    attr_reader :notification_url, :contacts_url
+
+    def initialize
+      self.host          = 'https://chatty-crow.com/api/v1/'
+      @token             = nil
+      @default_channel   = nil
+      @http_open_timeout = 2
+      @http_read_timeout = 5
+    end
+
+    def host=(s)
+      @host             = s
+      @notification_url = s + (s[-1] == '/' ? '' : '/') + 'notification'
+      @contacts_url     = s + (s[-1] == '/' ? '' : '/') + 'contacts'
+    end
+  end
+end

data/lib/chatty_crow/contacts_request.rb

@@ -0,0 +1,79 @@
+require 'restclient'
+
+# Send request to contacts chattycrow API
+module ChattyCrow
+  # Module contains request for contacts
+  module ContactsRequest
+    # Add contact request
+    # @params args [Arguments]
+    # @return [Response::ContactsAdd] Instance
+    def self.add(*args)
+      # Send contact request
+      send_contact_request(Response::ContactsAdd, :post, *args)
+    end
+
+    # Remove contact request
+    # @params args [Arguments]
+    # @return [Response::ContactsRemove] Instance
+    def self.remove(*args)
+      # Send contact request
+      send_contact_request(Response::ContactsRemove, :delete, *args)
+    end
+
+    # Return default contacts url
+    def self.contacts_url
+      ChattyCrow.configuration.contacts_url
+    end
+
+    # Method prepare data from add/remove contact
+    # @params klass [Class] Initializable class for response
+    # @params method [String] HTTP method
+    # @params *ąrgs [Arguments]
+    def self.send_contact_request(klass, method, *args)
+      # Parse options
+      options = ChattyCrow.extract_options!(args)
+
+      # Invalid argument
+      fail ::ArgumentError if args.length == 0
+
+      # Set as payload
+      options[:payload] = { contacts: args }
+
+      # Send command
+      execute(options.merge(method: method)) do |response|
+        klass.new response
+      end
+    end
+
+    # Method actually sends created request to server
+    #
+    # @param options [Hash] Options for request
+    # @param resp_block [Block] Block what to do with sucessfull response
+    # @return [Object] Block given execute or RestClient::Response
+    def self.execute(options, &resp_block)
+      # Prepare options (url + headers)
+      options[:url]     = contacts_url
+      options[:headers] = ChattyCrow.default_headers(options.delete(:channel), options.delete(:token))
+
+      # Send request
+      RestClient::Request.execute(options) do |response, request, result, &block|
+        case response.code
+        when 200, 201
+          if block_given?
+            resp_block.call(response)
+          else
+            response
+          end
+        when 301, 302, 307
+          response.follow_redirection(request, result, &block)
+        when 401
+          fail Error::UnauthorizedRequest, response
+        when 404
+          fail Error::ChannelNotFound, response
+        else
+          fail Error::InvalidReturn, response
+        end
+      end
+    end
+  end
+end

data/lib/chatty_crow/error.rb

@@ -0,0 +1,26 @@
+# Parent of all ChattyCrow errors
+module ChattyCrow
+  module Error
+    # Parent of all chatty crow error
+    # designed to accept RestClient::Response
+    class ChattyCrowError < StandardError
+      # Json parsed response body
+      attr_accessor :response_body, :response
+
+      def initialize(response = nil)
+        @response = response
+        if @response && @response.body
+          @response_body = JSON.parse(@response.body)
+          super(@response_body['msg']) if @response_body['msg']
+        end
+      rescue JSON::ParserError
+        @response_body = nil
+      end
+    end
+  end
+end
+
+Dir[File.dirname(__FILE__) + '/error/*.rb'].sort.each do |path|
+  filename = File.basename(path)
+  require "chatty_crow/error/#{filename}"
+end

data/lib/chatty_crow/error/channel_not_found.rb

@@ -0,0 +1,6 @@
+module ChattyCrow
+  module Error
+    class ChannelNotFound < ChattyCrowError
+    end
+  end
+end

data/lib/chatty_crow/error/invalid_attributes.rb

@@ -0,0 +1,21 @@
+module ChattyCrow
+  module Error
+    # Invalid attributes exception
+    # throws when some of attributes is missing
+    class InvalidAttributes < ChattyCrowError
+      # List of invalid attributes
+      attr_accessor :attributes
+
+      def initialize(response = nil)
+        super response
+
+        # Get parameters from response
+        if @response_body && @response_body['parameters']
+          @attributes = @response_body['parameters']
+        else
+          @attributes = []
+        end
+      end
+    end
+  end
+end

data/lib/chatty_crow/error/invalid_return.rb

@@ -0,0 +1,7 @@
+module ChattyCrow
+  module Error
+    # Something weird happend!
+    class InvalidReturn < ChattyCrowError
+    end
+  end
+end

data/lib/chatty_crow/error/unauthorized_request.rb

@@ -0,0 +1,6 @@
+module ChattyCrow
+  module Error
+    class UnauthorizedRequest < ChattyCrowError
+    end
+  end
+end

data/lib/chatty_crow/notification_request.rb

@@ -0,0 +1,54 @@
+require 'rest_client'
+
+module ChattyCrow
+  # Notification request
+  # use for send different kind
+  # of notifications
+  class NotificationRequest
+    # Prepare and send request
+    # @param klass [Object] Notification specific class
+    # @param args [Array] Arguments
+    def self.send(klass, *args)
+      instance = klass.new(*args)
+      execute(instance)
+    end
+
+    # :nodoc:
+    def self.notification_url
+      ChattyCrow.configuration.notification_url
+    end
+
+    # Method actually sends created request to server
+    # @param instance [Request::Base] Request children class
+    # @param raise_errors [Boolean] Raise errors if error?
+    # @return [Object] Raise an exception or return Response::Notification
+    def self.execute(instance, raise_errors = true)
+      options = instance.to_json.merge(url: notification_url, method: :post)
+
+      RestClient::Request.execute(options) do |response, request, result, &block|
+        begin
+          case response.code
+          when 200, 201
+            Response::Notification.new response
+          when 301, 302, 307
+            response.follow_redirection(request, result, &block)
+          when 400
+            fail Error::InvalidAttributes, response
+          when 401
+            fail Error::UnauthorizedRequest, response
+          when 404
+            fail Error::ChannelNotFound, response
+          else
+            fail Error::InvalidReturn, response
+          end
+        rescue => e
+          if raise_errors
+            raise e
+          else
+            false
+          end
+        end
+      end # RestClient
+    end # Execute
+  end
+end

data/lib/chatty_crow/railtie.rb

@@ -0,0 +1,10 @@
+module ChattyCrow
+  # ChattyCrow rails integration
+  class Railtie < ::Rails::Railtie
+    initializer 'chatty_crow.initialize_from_rails' do
+      config.after_initialize do
+        ChattyCrow.configure_from_rails
+      end
+    end
+  end
+end

data/lib/chatty_crow/request.rb

@@ -0,0 +1,53 @@
+module ChattyCrow
+  module Request
+    # Parent of all requests to ChattyCrow API
+    class BaseRequest
+      # Methods
+      attr_accessor :contacts, :payload, :channel, :token
+
+      # Intialize options!
+      attr_accessor :arguments, :options, :arguments_flatten
+
+      # Intialize (almost everwhere called by super)
+      # @param args [Array] options for request
+      def initialize(*args)
+        # Error when attributes not exists!
+        fail ::ArgumentError if args.empty?
+
+        # Parse options and arguments
+        # Arguments can be simple message!
+        @options   = ChattyCrow.extract_options!(args)
+        @arguments = args
+
+        # Create flatten arguments for (skype/android/sms.. requests)
+        @arguments_flatten = args.join(', ') if args.any?
+
+        # Recipients
+        @contacts = ChattyCrow.wrap(@options.delete(:contacts)).compact
+
+        # Channel
+        @channel = @options.delete(:channel)
+
+        # Token
+        @token   = @options.delete(:token)
+      end
+
+      # Return chatty crow default headers for specific channel
+      def headers
+        ChattyCrow.default_headers(@channel, @token)
+      end
+
+      # Get request for send
+      # @return [Hash] Request
+      def to_json
+        {
+          payload: {
+            payload: payload,
+            contacts: @contacts
+          },
+          headers: headers
+        }
+      end
+    end
+  end
+end