appboy 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9222a09ffa3f7d75b06a1366c1845b02c42ccef8
-  data.tar.gz: 45ada71360cdd58a539e7d4763e6a9cd2b4cf1f7
+SHA256:
+  metadata.gz: e8e7d2efd3c2b0f0e598b7c9837141dcdb4808bc2bfb0248f4bdb6a21d1a444c
+  data.tar.gz: 4c7e5076d689f7c7c2930309be8f0df558da1723e3178b4591acfb7e91b343b1
 SHA512:
-  metadata.gz: 7811017c20de7850940245f6e8d6b921fd454d4fe8c007d7628c6622c4f0b86a2297151562c73beebbc6f8adb64c56417446a21396aca68611aa4b1e0fea0c64
-  data.tar.gz: db42fb17c83fa3fa23a14fb23d86bd1a7517c1e1e746c8732dc376511cba5c9e6f9e95f88ba08c11ed24c0186803f6832701fdf515b964d5a9421b80d450bb8a
+  metadata.gz: d3f74d0bcf12e255858773a5ab749cbd9d2af5ac5634adce7a1cc0e8ccd95acbd255114a444c494f15dfba2af96a3cff78b3b2926da042602b8c9590a79cb90f
+  data.tar.gz: 3dfdcc2203ec7d87e46027cca841f6dc3b35a1a4501314021440f07c28ec17e26532d60b2387a9d05c9deeeccfe203823b57cf76c1e90203c626d4287f8fcd6a

data/README.md

@@ -24,6 +24,12 @@ Or install it yourself as:
 api = Appboy::API.new('<app-group-id>')
 ```
 
+By default Appboy will be using 'https://api.appboy.com' as the default REST API base url, but you can override this base url by setting the env variable `APPBOY_REST_BASE_URL`. E.G.
+
+```
+APPBOY_REST_BASE_URL="https://rest.iad-01.braze.com" 
+```
+
 ### Track User Attributes
 
 See: [User Attributes Object Specification](https://documentation.appboy.com/REST_APIs/User_Data#user-attribute-object)
@@ -53,7 +59,7 @@ api.track_users(events: [{
   external_id: 123,
   name: 'add-to-cart',
   time: Time.now
-}]
+}])
 ```
 
 ##### Track Events for Single User
@@ -73,7 +79,7 @@ api.track_users(purchases: [{
   currency: 'CAD',
   price: 1.99,
   time: Time.now
-}]
+}])
 ```
 
 ##### Track Purchases for Single User
@@ -154,7 +160,15 @@ api.export_users(external_ids: [1])
 api.export_users(segment_id: segment_id, callback_endpoint: 'https://example.com')
 ```
 
+## Debugging
 
+The APPBOY_DEBUG environment variable will trigger full printouts of the Faraday gem's HTTP requests and responses.
+
+```bash
+cd /my/app
+export APPBOY_DEBUG=true
+bundle exec rails whatever
+```
 
 ## Contributing
 

data/lib/appboy/http.rb

@@ -14,11 +14,19 @@ module Appboy
     end
 
     def connection
-      @connection ||= Faraday.new(url: 'https://api.appboy.com') do |connection|
+      @connection ||= Faraday.new(url: api_host) do |connection|
         connection.request :json
 
+        connection.response :logger if ENV['APPBOY_DEBUG']
+
         connection.adapter Faraday.default_adapter
       end
     end
+
+    private
+
+    def api_host
+      @api_host ||= ENV.fetch('APPBOY_REST_BASE_URL', 'https://api.appboy.com')
+    end
   end
 end

data/lib/appboy/version.rb

@@ -1,3 +1,3 @@
 module Appboy
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
 end

data/spec/appboy/http_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'appboy/http'
+
+describe Appboy::HTTP do
+  describe '#connection' do
+    it 'sets the default url prefix' do
+      expect(subject.connection.url_prefix.to_s).to eql "https://api.appboy.com/"
+    end
+
+    context 'when the env contains `APPBOY_REST_BASE_URL` env variable' do
+      before { ENV['APPBOY_REST_BASE_URL'] = "https://new.braze.com" }
+      after  { ENV.delete('APPBOY_REST_BASE_URL') }
+
+      it 'initializes the connection with it' do
+        expect(subject.connection.url_prefix.to_s).to eql "https://new.braze.com/"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appboy
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Josh Nussbaum
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2018-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -213,6 +213,7 @@ files:
 - lib/appboy/version.rb
 - spec/appboy/api_spec.rb
 - spec/appboy/endpoints/track_users_spec.rb
+- spec/appboy/http_spec.rb
 - spec/appboy/rest/email_status_spec.rb
 - spec/appboy/rest/export_users_spec.rb
 - spec/appboy/rest/schedule_messages_spec.rb
@@ -266,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A wrapper for the Appboy REST API, track users/events/purchases, send & schedule
@@ -274,6 +275,7 @@ summary: A wrapper for the Appboy REST API, track users/events/purchases, send &
 test_files:
 - spec/appboy/api_spec.rb
 - spec/appboy/endpoints/track_users_spec.rb
+- spec/appboy/http_spec.rb
 - spec/appboy/rest/email_status_spec.rb
 - spec/appboy/rest/export_users_spec.rb
 - spec/appboy/rest/schedule_messages_spec.rb