realpush 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07b50b05342cbf396b21078cc541a86da0e1a687
+  data.tar.gz: 321537b3c17e1374f98bbdcf7241c1b581f5adbc
+SHA512:
+  metadata.gz: a9e10ec0da01ba0d3400cafae4a9d6e677e00c3a9f0cfc73d9df8db9a3c4950d94efd737458fbe0e4f10de3c20fab5651738ee099cb472cfd7841f6d6f0bb9e8
+  data.tar.gz: 716862c51d40e618b65cc6ceee994a8675e8542c2e8284aa5f6f86d35eab268287b26d1833743b06555ae0d5aecf6e7f42d67780973221b93ebad60074f3935e

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+
+before_install:
+  - gem install bundler
+
+cache: bundler
+
+sudo: false
+
+script:
+  - bundle exec rspec
+
+rvm:
+  - 2.0.0
+  - 2.1.2
+  - 2.1.5
+  - 2.2
+
+addons:
+  code_climate:
+    repo_token: 868adb2fbaf42e5f24e170dee9e89a4385a181dc0de2c9f61b288eb4c40de307

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,77 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Zaez Inovação Digital
+
+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,24 @@
+RealPush [![Build Status](https://travis-ci.org/zaeznet/realpush-ruby.svg?branch=master)](https://travis-ci.org/zaeznet/realpush-ruby) [![Dependency Status](https://gemnasium.com/zaeznet/realpush-ruby.svg)](https://gemnasium.com/zaeznet/realpush-ruby) [![Code Climate](https://codeclimate.com/github/zaeznet/realpush-ruby/badges/gpa.svg)](https://codeclimate.com/github/zaeznet/realpush-ruby) [![Test Coverage](https://codeclimate.com/github/zaeznet/realpush-ruby/badges/coverage.svg)](https://codeclimate.com/github/zaeznet/realpush-ruby) [![Inline docs](http://inch-ci.org/github/zaeznet/realpush-ruby.svg?branch=master)](http://inch-ci.org/github/zaeznet/realpush-ruby)
+========
+**RealPush Library for Ruby**
+
+## Installation & Configuration
+
+Add realpush to your Gemfile, and then run bundle install
+
+```ruby
+gem 'realpush'
+```
+
+or install via gem
+
+```bash
+gem install realpush
+```
+
+After registering at http://realpush.cc/ configure your app with the security credentials.
+
+## Usage
+
+TODO: Write usage instructions here
+

data/Rakefile

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

data/lib/realpush.rb

@@ -0,0 +1,55 @@
+autoload 'Logger', 'logger'
+require 'active_support/all'
+
+module RealPush
+  # All errors descend from this class so they can be easily rescued
+  #
+  # @example
+  #   begin
+  #     RealPush.trigger('channel_name', 'event_name, {:some => 'data'})
+  #   rescue RealPush::Error => e
+  #     # Do something on error
+  #   end
+  class Error < RuntimeError; end
+  class AuthenticationError < Error; end
+  class ConfigurationError < Error; end
+  class HTTPError < Error; end
+
+  API_VERSION_BE  = 'v1'
+  API_VERSION_APP = 'v1'
+
+  autoload :Client,   'realpush/client'
+  autoload :Request,  'realpush/request'
+  autoload :Resource, 'realpush/resource'
+
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= begin
+        log = Logger.new($stdout)
+        log.level = Logger::INFO
+        log
+      end
+    end
+
+    def default_client
+      @default_client ||= Client.new
+    end
+
+    %w(trigger trigger_async post post_async get get_async).each do |method|
+      delegate method, to: 'default_client'
+    end
+  end
+
+  module API
+    autoload :App,         'realpush/api/app'
+    autoload :Base,        'realpush/api/base'
+    autoload :BaseCreate,  'realpush/api/base_create'
+    autoload :BaseDestroy, 'realpush/api/base_destroy'
+    autoload :BaseList,    'realpush/api/base_list'
+    autoload :BaseUpdate,  'realpush/api/base_update'
+  end
+end
+
+require 'realpush/version'

data/lib/realpush/api/app.rb

@@ -0,0 +1,11 @@
+module RealPush
+  module API
+    class App
+      include RealPush::API::Base
+
+      configure base_path: 'apps'
+      accept_params :alias_name, :max_connections, :max_daily_messages, :status
+
+    end
+  end
+end

data/lib/realpush/api/base.rb

@@ -0,0 +1,155 @@
+require 'multi_json'
+
+module RealPush
+  module API
+    module Base
+      extend ActiveSupport::Concern
+
+      def self.included(base)
+        base.class_eval do
+
+          attr_reader :token
+
+          attr_accessor :connect_timeout, :send_timeout, :receive_timeout, :keep_alive_timeout
+
+          def initialize(token)
+            raise ConfigurationError, "Invalid token format: #{token}" if /^[-=\w]{43}={0,2}$/.match(token).nil?
+            @token = token
+            @params_accept = []
+
+            # Default timeouts
+            @connect_timeout = 5
+            @send_timeout = 5
+            @receive_timeout = 5
+            @keep_alive_timeout = 30
+          end
+
+          protected
+
+          # Sends a request to the specified URL.
+          #
+          # @param method [String | Symbol]
+          #     HTTP method to be sent.  method.to_s.upcase is used.
+          #
+          # @param uri [String | URI]
+          #     HTTP method to be sent.  method.to_s.upcase is used.
+          #
+          # @param query [Hash]
+          #     a Hash of query part of URL.
+          #     e.g. { "a" => "b" } => 'http://host/part?a=b'
+          #
+          # @param body [Hash]
+          #      a Hash of body part. e.g.
+          #      { "a" => "b" } => 'a=b'
+          #
+          # @param header [Hash]
+          #     a Hash of extra headers.  e.g.
+          #     { 'Accept' => 'text/html' }.
+          #
+          # @return [ HTTP::Message ]
+          def execute(method, uri, query={}, body={}, header={})
+            begin
+              response = httpclient.request(method, uri, query, body, header)
+            rescue HTTPClient::BadResponseError,
+                HTTPClient::TimeoutError,
+                SocketError,
+                Errno::ECONNREFUSED => e
+              raise RealPush::HTTPError, "#{e.message} (#{e.class})"
+            end
+          end
+
+          # TODO: nodoc
+          # @return [HTTPClient]
+          def httpclient
+            @client ||= begin
+              require 'httpclient'
+
+              HTTPClient.new(default_header: {'X-RealPush-Token' => token}).tap do |c|
+                c.connect_timeout = connect_timeout
+                c.send_timeout = send_timeout
+                c.receive_timeout = receive_timeout
+                c.keep_alive_timeout = keep_alive_timeout
+              end
+            end
+          end
+
+          # Capture the contents of the request and makes the JSON parse inside the BODY content.
+          #
+          # @param content [ HTTP::Message ]
+          #   Returns of self.httpclient
+          #
+          # @return [ Hash ]
+          def parse_content(content)
+            MultiJson.decode(content.body)
+          end
+
+          # Prepare the URL to the request, it contains the url pattern for API Version 1.0.
+          #
+          # :example:
+          #   url()                //=> https://app.realpush.cc/api/v1/
+          #   url('apps/123.json') //=> https://app.realpush.cc/api/v1/apps/123.json
+          #
+          # @param path [String]
+          #   Added in path of URL
+          #
+          # @return [URI]
+          def url(path='')
+            path = "/#{path}" unless path.start_with? '/'
+            URI::Generic.build({
+                                   :scheme => 'https',
+                                   :host   => 'app.realpush.cc',
+                                   :port   => 443,
+                                   :path   => "/api/#{RealPush::API_VERSION_BE}#{path}"
+                               })
+          end
+
+          # Validate a params accepted
+          #
+          # @param params [Hash]
+          #
+          # @return [TrueClass]
+          def valid_params?(params)
+            params.keys.each do |key|
+              unless RealPush::API::App.params_accept.include? key.to_sym
+                raise ConfigurationError, "Invalid parameter! ( #{RealPush::API::App.params_accept.join(', ')} )"
+              end
+            end
+            true
+          end
+
+        end
+      end
+
+      module ClassMethods
+        attr_reader :params_accept, :params
+
+        def accept_params(*args)
+          @params_accept ||= []
+          args.each do |field|
+            @params_accept << field
+          end
+        end
+
+        def configure(params={})
+          @params = {
+              base_path: nil,
+              modules: [
+                  :list,
+                  :create,
+                  :update,
+                  :destroy
+              ]
+          }.deep_merge(params.symbolize_keys)
+          raise ConfigurationError, 'Invalid parameters, you need a "base_path"' unless params[:base_path]
+          @params[:modules].each do |a|
+            a = a.to_s.downcase
+            send(:include, Object.const_get("RealPush::API::Base#{a[0].upcase}#{a[1..-1]}"))
+          end
+        end
+
+
+      end
+    end
+
+  end
+end

data/lib/realpush/api/base_create.rb

@@ -0,0 +1,21 @@
+module RealPush
+  module API
+    module BaseCreate
+      extend ActiveSupport::Concern
+
+      def self.included(base)
+        base.class_eval do
+          def create(data)
+            valid_params? data
+            content = execute :post, url("#{self.class.params[:base_path]}.json"), {}, data
+            parse_content content
+          rescue RealPush::HTTPError,
+                 RealPush::ConfigurationError => e
+            raise RealPush::ConfigurationError, e.message
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/realpush/api/base_destroy.rb

@@ -0,0 +1,22 @@
+module RealPush
+  module API
+    module BaseDestroy
+      extend ActiveSupport::Concern
+
+      def self.included(base)
+        base.class_eval do
+          def destroy(id)
+            content = execute :delete, url("#{self.class.params[:base_path]}/#{id}.json")
+            content.status == 204
+          rescue RealPush::HTTPError => e
+            {
+                status: :ERROR,
+                message: e.message
+            }
+          end
+        end
+      end
+
+    end
+  end
+end