appboy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9b08323e1d2602a33183a99f18a06a7bb59ad1e
+  data.tar.gz: 984094644be733e86940bb0e4b6d2c0dcf397d36
+SHA512:
+  metadata.gz: 4f39f353d4618c26b0b340ea7580d535042f40baf1b03e74c578d80066db094b70e65f283e1a408a54b6946087a436417788da032265e2e4168131fcce10fc8c
+  data.tar.gz: ec645bebf908780c2d633bdb18b7e211b72d304024ccf5afcb02e519921db65b49373bd3626489e4dd8573779a6ae2fcc2427fa29502800d901535907c1cbc8b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Josh Nussbaum
+
+MIT License
+
+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,75 @@
+# Appboy
+
+A wrapper for the Appboy REST API using HTTParty
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'appboy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install appboy
+
+## Examples
+
+### Initializing API
+
+```ruby
+api = Appboy::API.new('<secret>', '<app-group-id>')
+```
+
+### Track User
+
+```ruby
+api.track [{external_id: 123,
+            first_name: 'John',
+            last_name: 'Smith',
+            gender: 'male',
+            email: 'jsmith@example.com'}]
+```
+
+### Track Event
+
+```ruby
+events = [
+  {external_id: 123, name: 'add-to-cart', time: Time.now}
+]
+api.track [], events
+```
+
+### Track Purchase
+### Send Message
+
+```ruby
+message  = {android_push: {alert: 'Hello Android'},
+            apple_push:   {alert: "Hello iOS"}}
+
+user_ids = [123, 456]
+
+api.send_message(message, user_ids)
+```
+
+### Schedule Message
+
+```ruby
+message    = {android_push: {alert: 'Hello Android'},
+              apple_push:   {alert: "Hello iOS"}}
+segment_id = '<segment id>'
+send_at    = Time.new(2014, 3, 12)
+
+api.schedule_message(send_at, message, segment_id)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/appboy.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'appboy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "appboy"
+  spec.version       = Appboy::VERSION
+  spec.authors       = ["Josh Nussbaum"]
+  spec.email         = ["josh@godynamo.com"]
+  spec.description   = %q{Appboy wrapper}
+  spec.summary       = %q{A wrapper for the Appboy REST API, track users/events/purchases, send & schedule messages}
+  spec.homepage      = "http://appboy.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/appboy.rb

@@ -0,0 +1,6 @@
+require "appboy/version"
+require 'httparty'
+
+module Appboy
+  autoload :API, "appboy/api"
+end

data/lib/appboy/api.rb

@@ -0,0 +1,42 @@
+module Appboy
+  class API
+    include HTTParty
+
+    base_uri 'https://api.appboy.com'
+
+    def initialize(secret, app_group_id)
+      @secret, @app_group_id = secret, app_group_id
+    end
+
+    def track(attributes, events=[], purchases=[])
+      post '/users/track', company_secret: @secret,
+                           app_group_id:   @app_group_id,
+                           attributes:     attributes,
+                           events:         events,
+                           purchases:      purchases
+    end
+
+    def send_message(message, user_ids, segment_id = nil)
+      post '/messages/send', company_secret:    @secret,
+                             app_group_id:      @app_group_id,
+                             messages:          message,
+                             external_user_ids: user_ids,
+                             segment_ids:       [segment_id].compact
+    end
+
+    def schedule_message(date, message, segment_id, local_timezone=false)
+      post '/messages/schedule', company_secret:            @secret,
+                                 segment_ids:               [segment_id],
+                                 send_at:                   date,
+                                 deliver_in_local_timezone: local_timezone,
+                                 messages:                  message
+    end
+
+  private
+    def post(url, payload)
+      response = self.class.post(url, query: payload)
+      puts response.inspect
+      response['message'] == 'success'
+    end
+  end
+end

data/lib/appboy/version.rb

@@ -0,0 +1,3 @@
+module Appboy
+  VERSION = "0.0.1"
+end

data/spec/api_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Appboy::API do
+  let(:appboy) { Appboy::API.new('secret-key', 'app-group-id')}
+
+  context "#track" do
+    it "calls api" do
+      Appboy::API.should_receive(:post).with(
+        '/users/track',
+        query: {
+          company_secret: 'secret-key',
+          app_group_id: 'app-group-id',
+          attributes: :attributes,
+          events: :events,
+          purchases: :purchases
+        }
+      ).and_return('message' => 'success')
+
+      expect(appboy.track(:attributes, :events, :purchases)).to be_true
+    end
+
+    it "handles error"
+  end
+
+  context "#send_message" do
+    it "calls api" do
+      Appboy::API.should_receive(:post).with(
+        '/messages/send',
+        query: {
+          company_secret: 'secret-key',
+          app_group_id: 'app-group-id',
+          external_user_ids: :user_ids,
+          segment_ids: [:segment_id],
+          messages: :message
+        }
+      ).and_return('message' => 'success')
+
+      expect(appboy.send_message(:message, :user_ids, :segment_id)).to be_true
+    end
+    it "handles error"
+  end
+
+  context "#schedule_message" do
+    it "calls api" do
+      Appboy::API.should_receive(:post).with(
+        '/messages/schedule',
+        query: {
+          company_secret: 'secret-key',
+          segment_ids: [:segment_id],
+          send_at: :date,
+          deliver_in_local_timezone: :in_local_timezone,
+          messages: :message
+        }
+      ).and_return('message' => 'success')
+
+      expect(appboy.schedule_message(:date, :message, :segment_id, :in_local_timezone)).to be_true
+    end
+    it "handles error"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'appboy'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: appboy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Nussbaum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Appboy wrapper
+email:
+- josh@godynamo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appboy.gemspec
+- lib/appboy.rb
+- lib/appboy/api.rb
+- lib/appboy/version.rb
+- spec/api_spec.rb
+- spec/spec_helper.rb
+homepage: http://appboy.com
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A wrapper for the Appboy REST API, track users/events/purchases, send & schedule
+  messages
+test_files:
+- spec/api_spec.rb
+- spec/spec_helper.rb
+has_rdoc: