batch_push_notification 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3c42474a440ab41b0d48998a444ca7ddebfe69d
+  data.tar.gz: c8225b3b9511d8db02a77a5934dc2f67114447e2
+SHA512:
+  metadata.gz: e19b5a2570f2caf60448df8fcaf2d2f619b28be5cb2d9bd66e0190eede2a2197810a03d7e1048692ad97a888a6592cd697996f67de229c8c8c8ddc8ce69b710b
+  data.tar.gz: 47d1053b41bdf2400fe03ec510b3b0622add728a4ed56c6fafdd6756ea2faf4fa839b1fc1056dd216360de12ee3eb10db3bff4e1d305d0882cee0346dcffed6f

data/lib/batch_push_notification.rb

@@ -0,0 +1,9 @@
+module BatchPushNotification
+  autoload :Configurable, 'batch_push_notification/configurable'
+  autoload :Client,  'batch_push_notification/client'
+  autoload :Notification,  'batch_push_notification/notification'
+
+  class << self
+    include BatchPushNotification::Configurable
+  end
+end

data/lib/batch_push_notification/Notification.rb

@@ -0,0 +1,28 @@
+module BatchPushNotification
+  class Notification
+    def initialize(args = {})
+      @group_id = args[:group_id]
+      @tokens = args[:tokens]
+      @custom_ids = args[:custom_ids]
+      @title = args[:title]
+      @body = args[:body]
+      @custom_payload = args[:custom_payload]
+    end
+
+    def payload
+      {
+          "group_id": @group_id,
+          "recipients": {
+              "tokens": @tokens,
+              "custom_ids": @custom_ids
+          },
+          "message": {
+              "title": @title,
+              "body": @body
+          },
+          "custom_payload": @custom_payload.to_json.to_s, # the API expects a string instead of a JSON object
+          sandbox: BatchPushNotification.sandbox
+      }.to_json
+    end
+  end
+end

data/lib/batch_push_notification/client.rb

@@ -0,0 +1,30 @@
+require 'json'
+require 'faraday'
+
+module BatchPushNotification
+  class Client
+    def initialize
+      # fail if the required params are not set:
+      raise(StandardError, 'Configuration is missing') unless BatchPushNotification.endpoint && BatchPushNotification.api_key && BatchPushNotification.rest_api_key && !BatchPushNotification.sandbox.nil?
+    end
+
+    def send_notification(notification)
+      response = connection.post send_url, notification.payload
+      return JSON.parse(response.body)
+    end
+
+    def connection
+      return Faraday.new(:url => BatchPushNotification.endpoint) do |faraday|
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.headers['Content-Type'] = 'application/json'
+        faraday.headers['X-Authorization'] = BatchPushNotification.rest_api_key
+
+        faraday.adapter Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+    def send_url
+      BatchPushNotification.api_key + '/transactional/send'
+    end
+  end
+end

data/lib/batch_push_notification/configurable.rb

@@ -0,0 +1,34 @@
+# Based on https://github.com/sethvargo/chef-api/blob/master/lib/chef-api/configurable.rb
+module BatchPushNotification
+  #
+  # Use this class to configure the Client
+  #
+  module Configurable
+    class << self
+
+      def keys
+        @keys = [
+            :endpoint,
+            :api_key,
+            :rest_api_key,
+            :sandbox
+        ]
+      end
+    end
+
+    BatchPushNotification::Configurable.keys.each do |key|
+      attr_accessor key
+    end
+
+    #
+    # Configure the client like this:
+    #
+    # BatchPushNotification.configure do |config|
+    #   config.endpoint = "https://api.batch.com/1.0/"
+    # end
+    #
+    def configure
+      yield self
+    end
+  end
+end

data/spec/batch_push_notification/client_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+RSpec.describe BatchPushNotification::Client do
+
+  let(:endpoint) {"https://api.batch.com/1.0/"}
+  let(:api_key) {""}
+  let(:rest_api_key) {""}
+
+  # notification
+  let(:group_id) {'test'}
+  let(:tokens) { [""] }
+
+  let(:title) { 'Title' }
+  let(:body) { 'Body2' }
+  let(:sandbox) { false }
+
+  let(:custom_payload) { {:poll_id => 1} }
+  let(:notification) { BatchPushNotification::Notification.new({group_id: group_id, tokens: tokens, title: title, body: body, custom_payload: custom_payload}) }
+
+  #def initialize(group_id, tokens = [], custom_ids = [], title, body, custom_payload)
+
+  before {
+    BatchPushNotification.configure do |config|
+      config.endpoint = endpoint
+      config.api_key = api_key
+      config.rest_api_key = rest_api_key
+      config.sandbox = sandbox
+    end
+  }
+
+
+  it "can send a notification" do
+    client = BatchPushNotification::Client.new
+    response = client.send_notification(notification)
+
+    expect(response['token']).to_not be_nil
+  end
+end

data/spec/batch_push_notification/configurable_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+RSpec.describe BatchPushNotification do
+
+  let(:endpoint) {"https://api.batch.com/1.0/"}
+  let(:api_key) {""}
+  let(:rest_api_key) {""}
+
+
+  it "can be configured using a block" do
+
+    BatchPushNotification.configure do |config|
+      config.endpoint = endpoint
+      config.api_key = api_key
+      config.rest_api_key = rest_api_key
+    end
+
+    expect(BatchPushNotification.endpoint).to eq(endpoint)
+    expect(BatchPushNotification.api_key).to eq(api_key)
+    expect(BatchPushNotification.rest_api_key).to eq(rest_api_key)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+require 'batch_push_notification'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: batch_push_notification
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Nicholas Wittstruck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A client for the batch.com Push Notification API
+email: n.wittstruck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/batch_push_notification.rb
+- lib/batch_push_notification/Notification.rb
+- lib/batch_push_notification/client.rb
+- lib/batch_push_notification/configurable.rb
+- spec/batch_push_notification/client_spec.rb
+- spec/batch_push_notification/configurable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nwittstruck/batch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Batch
+test_files:
+- spec/batch_push_notification/client_spec.rb
+- spec/batch_push_notification/configurable_spec.rb
+- spec/spec_helper.rb