one_signal 0.0.14 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07b611d3394091ab3465667f2d3c3fb2b133a187
-  data.tar.gz: 79759f5f3e6213d6b7c6118cc4929b6f517e493b
+  metadata.gz: ea70b55c5209ae2e1d55b7b24728dbe125031707
+  data.tar.gz: e7c77d266e4ea20bc0cc7650925c0fc2a214bc47
 SHA512:
-  metadata.gz: 3faac17bb9a87c791984cf5d30c49fada0a1191486cfdfad15a9c86b99929be1f2d219b9857ef0217337744281184f44d2f4d1e3e964366fadf71ae9ad3f7ab4
-  data.tar.gz: 59e1002563a7111e9574086480fe384eca3a1808f870d0a6f8e0cdadcf78020efa057a285c8bd6502fbe04eebd4883aa6d0ddb0a902df0b235738ba4138ac093
+  metadata.gz: f20b6d9543e7c9dd390cd138475ee339ffb5d8eea96a7fd6a932990a80ab789589bbcd77c50bc01d76e15c5280b8725932ef4a22fbc511e375c92d4decc49886
+  data.tar.gz: c1f3aef54be919fc7ec8216d5793c8cf1ee4538aa5888e85f340b5953a79a1d93b50dda07c20a4699b83883ded0ad07365258978526ab29686a987d791d1af16

data/.env.example

@@ -0,0 +1,2 @@
+ONESIGNAL_USER_AUTH_KEY=YOUR_USER_AUTH_KEY_HERE
+ONESIGNAL_API_KEY=YOUR_API_KEY_HERE

data/CHANGELOG.txt

@@ -1,3 +1,7 @@
+=== 1.0.0 2016-02-23
+
+* Update Player#csv_export for API consistency
+
 === 0.0.14 2016-02-22
 
 * Change ruby required version from 2.2.0 to 2.1.0 

data/README.md

@@ -1,4 +1,4 @@
-# OneSignal Ruby bindings
+# OneSignal Ruby bindings [![Build Status](https://travis-ci.org/tbalthazar/onesignal-ruby.svg?branch=master)](https://travis-ci.org/tbalthazar/onesignal-ruby)
 
 This gem provides a simple SDK to access the [OneSignal API](https://documentation.onesignal.com/docs/server-api-overview).
 
@@ -18,7 +18,11 @@ bundle exec rake
 
 ## Basic usage
 
-See basic examples in [example.rb](/example.rb)
+See basic examples in [example.rb](/example.rb).
+To run it:
+- rename [.env.example](/.env.example) into `.env`
+- set your `USER_AUTH_KEY` and `API_KEY` in the `.env` file
+- run `ruby example.rb`
 
 ## Documentation
 

data/example.rb

@@ -1,309 +1,53 @@
 require 'one_signal'
 require 'dotenv'
 
+# load your keys with https://github.com/bkeepers/dotenv
 Dotenv.load
 api_key = ENV['ONESIGNAL_API_KEY']
 user_auth_key = ENV['ONESIGNAL_USER_AUTH_KEY']
-@app_id = ENV['ONESIGNAL_APP_ID']
-@device_token = "abcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabc3"
-@example_player_id = ENV['EXAMPLE_PLAYER_ID']
 
+# configure OneSignal
 OneSignal::OneSignal.api_key = api_key
 OneSignal::OneSignal.user_auth_key = user_auth_key
 
-def create_player
-  params = {
-    app_id: @app_id,
-    device_type: 0,
-    identifier: @device_token,
-    tags: {
-      user_id: 'test2',
-      device_type: 'chrome'
-    }
-  }
-
-  begin 
-    response = OneSignal::Player.create(params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-    puts "id : #{JSON.parse(response.body).class}"
-    return JSON.parse(response.body)["id"]
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def create_player_session(id:)
-  params = {
-    # app_id: @app_id,
-    # device_type: 0,
-    # identifier: @device_token,
-    # tags: {
-    #   user_id: 'test2',
-    #   device_type: 'chrome'
-    # }
-    device_os: 'iPhone5,1',
-    game_version: '1.0.6',
-    timezone: -28800
-  }
-
-  begin 
-    response = OneSignal::Player.create_session(id: id, params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def create_player_purchase(id:)
-  params = {
-    purchases: [
-      {
-        sku: 'SKU123',
-        iso: 'USD',
-        amount: '0.99'
-      }
-    ]
-  }
-
-  begin 
-    response = OneSignal::Player.create_purchase(id: id, params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def create_player_focus(id:)
-  params = {
-    state: 'ping',
-    active_time: 60
-  }
-
-  begin 
-    response = OneSignal::Player.create_focus(id: id, params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def update_player(id:)
-  params = {
-    app_id: @app_id,
-    device_type: 0,
-    identifier: @device_token,
-    tags: {
-      user_id: 'test2updated',
-      device_type: 'chrome'
-    }
-  }
-
-  begin 
-    response = OneSignal::Player.update(id: id, params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-    puts "id : #{JSON.parse(response.body).class}"
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def all_notifs
-  params = {
-    app_id: @app_id,
-    limit: 5,
-    offset: 0
-  }
-
-  begin 
-    response = OneSignal::Notification.all(params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-    puts "id : #{JSON.parse(response.body).class}"
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def get_notif(id:)
-  params = {
-    app_id: @app_id
-  }
-
-  begin 
-    response = OneSignal::Notification.get(id: id, params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-    puts "id : #{JSON.parse(response.body).class}"
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def notify
-  params = {
-    app_id: @app_id,
-    contents: {
-      en: 'hey buddy'
-    },
-    ios_badgeType: 'None',
-    ios_badgeCount: 1,
-    tags: [
-      {
-        key: 'user_id',
-        relation: '=',
-        value: "2"
-      },
-      { operator: 'AND' },
-      {
-        key: 'device_type',
-        relation: '=',
-        value: 'ios'
-      }
-    ]
-  }
-
-  begin 
-    response = OneSignal::Notification.create(params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-    body = JSON.parse(response.body)
-    return body["id"]
-  rescue OneSignal::NoRecipientsError => e
-    puts "--- NoRecipientsError: #{e.inspect}"
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  rescue OneSignal::OneSignalError => e
-    puts "--- OneSignalError  : #{e.inspect}"
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def csv_export
-  response = OneSignal::Player.csv_export(app_id: @app_id)
-  puts response.body
-end
-
-def all_players
-  response = OneSignal::Player.all(params: {app_id: @app_id, limit: 3})
-  puts response.body
+# create app
+params = {
+  name: 'test-app'
+}
+response = OneSignal::App.create(params: params)
+app_id = JSON.parse(response.body)["id"]
+puts "--- created app id: #{app_id}"
+
+# add a player
+device_token = "abcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabc1"
+params = {
+  app_id: app_id,
+  device_type: 0,
+  identifier: device_token,
+  tags: {
+    user_id: '123'
+  }
+}
+response = OneSignal::Player.create(params: params)
+player_id = JSON.parse(response.body)["id"]
+puts "--- created player id: #{player_id}"
+
+# notify the player (this will fail because we haven't configured the app yet)
+params = {
+  app_id: app_id,
+  contents: {
+    en: 'hello player'
+  },
+  ios_badgeType: 'None',
+  ios_badgeCount: 1,
+  include_player_ids: [player_id]
+}
+begin
+  response = OneSignal::Notification.create(params: params)
+  notification_id = JSON.parse(response.body)["id"]
+rescue OneSignal::OneSignalError => e
+  puts "--- OneSignalError  :"
+  puts "-- message : #{e.message}"
+  puts "-- status : #{e.http_status}"
+  puts "-- body : #{e.http_body}"
 end
-
-def get_player(id:)
-  response = OneSignal::Player.get(id: id)
-  puts response.body
-end
-
-def update_notif(id:)
-  params = {
-    app_id: @app_id,
-    opened: true
-  }
-  response = OneSignal::Notification.update(id: id, params: params)
-  puts response.body
-end
-
-def delete_notif(id:)
-  params = {
-    app_id: @app_id
-  }
-
-  begin 
-    response = OneSignal::Notification.delete(id: id, params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-    puts "id : #{JSON.parse(response.body).class}"
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def all_apps
-  begin 
-    response = OneSignal::App.all(params: nil)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-    puts "id : #{JSON.parse(response.body).class}"
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def get_app(id:)
-  response = OneSignal::App.get(id: id)
-  puts response.body
-end
-
-def create_app
-  params = {
-    name: 'footest'
-  }
-  response = OneSignal::App.create(params: params)
-  puts response.body
-end
-
-def update_app
-  params = {
-    name: 'bartest'
-  }
-  response = OneSignal::App.update(id: "29203a07-8f1f-438a-9932-9549c6b28c14",
-                                   params: params)
-  puts response.body
-end
-
-# player_id = create_player
-# update_player(id: player_id)
-player_id = '9c9a3fb4-62e0-455d-865b-670ccea594a1' 
-notification_id = 'c6e10bac-af7d-4879-a5e9-439de53e3cff'
-# create_player_session(id: player_id)
-# create_player_purchase(id: player_id)
-# create_player_focus(id: player_id)
-# notification_id = notify
-# puts "--- notif id: #{notification_id}"
-# csv_export
-# all_players
-# get_player(id: player_id)
-# all_notifs
-# get_notif(id: notification_id)
-# delete_notif(id: notification_id)
-# update_notif(id: notification_id)
-# get_notif(id: notification_id)
-# all_apps
-# get_app(id: @app_id)
-# create_app
-update_app

data/lib/one_signal/player.rb

@@ -2,12 +2,12 @@ module OneSignal
 
   class Player < OneSignal
 
-    def self.csv_export(app_id:)
+    def self.csv_export(params:)
       uri_string = @@base_uri
       uri_string += "/players/csv_export"
       uri = URI.parse(uri_string)
 
-      response = send_post_request(uri: uri, body: {app_id: app_id})
+      response = send_post_request(uri: uri, body: params)
 
       ensure_http_status(response: response,
                          status: '200',

data/lib/one_signal/version.rb

@@ -1,3 +1,3 @@
 module OneSignal
-  VERSION = "0.0.14"
+  VERSION = "1.0.0"
 end

data/one_signal.gemspec

@@ -2,7 +2,6 @@ require File.expand_path('lib/one_signal/version')
 
 Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.1.0'
-  s.add_runtime_dependency 'json', '~> 1.8'
   s.add_development_dependency 'rake', '~> 10.4'
   s.add_development_dependency 'mocha', '~> 1.1'
   s.add_development_dependency 'dotenv', '~> 2.0'

data/test/player_test.rb

@@ -33,12 +33,11 @@ class PlayerTest < MiniTest::Test
   end
 
   def test_csv_export
-    @app_id = "foobar"
     response = mock_response_ok
     OneSignal::OneSignal.expects(:send_post_request)
-                        .with(uri: @csv_export_uri, body: {app_id: @app_id})
+                        .with(uri: @csv_export_uri, body: @params)
                         .returns(response)
-    assert_equal response, OneSignal::Player.csv_export(app_id: @app_id)
+    assert_equal response, OneSignal::Player.csv_export(params: @params)
   end
 
   def test_all

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: one_signal
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 1.0.0
 platform: ruby
 authors:
 - Thomas Balthazar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +72,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.txt