greenfinch-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a282134674aace21f7223edad681e2bb60e0eb97
+  data.tar.gz: 49d76e99de2d64ba4f74807f473ff0f158e3822c
+SHA512:
+  metadata.gz: 836fb53b5efa265f2140d07f67b2e6b9f76efa2f411e9c4c2aae6c15dfe4b5f9058017e02842d512d32b50d38e4f48a95dcb71a267d57dc53a734b89a7929728
+  data.tar.gz: d2be292b934128ee61e7bede3048abc67498cc756b831cafbdd9abcaf5a04d7d03329c9e8792670e4461c07ba05805569534e8b905a095d90d3aeaec59148866

data/.gitignore

@@ -0,0 +1,5 @@
+*~
+Gemfile.lock
+html
+mixpanel-ruby*.gem
+.bundle

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Editor-based HTTP Client requests
+/httpRequests/

data/.idea/greenfinch-ruby.iml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.1.4, ruby-2.3.7-p456) [gem]" level="application" />
+  </component>
+</module>

data/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Rubocop" enabled="false" level="WARNING" enabled_by_default="false" />
+  </profile>
+</component>

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="ruby-2.3.7-p456" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/greenfinch-ruby.iml" filepath="$PROJECT_DIR$/.idea/greenfinch-ruby.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.6.0
+  - 2.5.0
+  - 2.3.0
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,190 @@
+Copyright 2012 Mixpanel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this work except in compliance with the License.
+You may obtain a copy of the License below, or at:
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,124 @@
+# GreenFinch Ruby Library
+![](https://upload.wikimedia.org/wikipedia/commons/3/32/Carduelis_chloris_3_%28Marek_Szczepanek%29.jpg)
+
+한국신용데이터 data lake로 서비스 내 각종 event를 전송하는 ruby library 입니다. 
+
+## 설치하기
+아래 2가지 방법을 지원합니다. 서비스 환경에 맞는 방법으로 설치하시기 바랍니다.
+### NPM으로 설치하기
+```sh
+npm install --save greenfinch
+```
+
+라이브러리 설치 후 발급받은 토큰와 서비스명으로 init후 track 호출로 이벤트 전송
+
+```javascript
+import greenfinch from 'greenfinch';
+
+greenfinch.init('<YOUR TOKEN>', {'service_name': '<YOUR SERVICE>', 'debug':true});
+greenfinch.track("An event");
+```
+
+### Javascript snippet으로 설치하기
+아래 snippet을 발급받은 토큰와 서비스명으로 치환 후 `<head></head>` 사이에 붙어넣기
+```html
+<script>window.GREENFINCH_CUSTOM_LIB_URL = 'https://asset.kcd.co.kr/js/greenfinch.min.js';</script>
+<script src="https://asset.kcd.co.kr/js/greenfinch-jslib-snippet.min.js"></script>
+<script type="text/javascript">greenfinch.init("<YOUR TOKEN>", {'service_name':'<YOUR SERVICE>', 'debug': true});</script>
+```
+
+## 기능
+### autotrack
+- page load시 pageview 이벤트가 자동으로 전송
+- dom click시 click 이벤트가 자동으로 전송
+
+### single page application
+- spa에서는 경로 변경 시 page load가 일어나지 않기 때문에 pageview 이벤트를 자동 전송하려면 page 변경 listener에 아래 코드 추가 필요
+```javascript
+greenfinch.page();
+```
+
+### 기본 수집 컬럼
+- browser_name
+- browser_version
+- current_url
+- host
+- referrer
+- insert_id(unique_id)
+- lib_version
+- os
+- pathname
+- screen_height
+- screen_width
+- title
+- session_id
+- time
+- utm_source, utm_medium, utm_campaign, utm_content, utm_term
+
+## 사용하기
+___
+### greenfinch.init
+greenfinch object를 초기화 하는 함수입니다. 아래와 같이 초기화 후 사용하시기 바랍니다.
+
+```javascript
+greenfinch.init('<YOUR TOKEN>', {'service_name': '<YOUR SERVICE>', 'debug':true or false});
+```
+
+| Argument | Type | Description |
+| ------------- | ------------- | ----- |
+| **token** | <span class="mp-arg-type">String, </span></br></span><span class="mp-arg-required">required</span> | 부여받은 token |
+| **config** | <span class="mp-arg-type">Object, </span></br></span><span class="mp-arg-required">required</span> | 초기화 시 필요한 config|
+| **options.service_name** | <span class="mp-arg-type">String, </span></br></span><span class="mp-arg-required">required</span> | 부여받은 service name |
+| **options.debug** | <span class="mp-arg-type">Boolean, </span></br></span><span class="mp-arg-required">required</span> | true: staging, false: production |
+
+
+___
+### greenfinch.track
+custom한 event를 전송하는 함수입니다.
+
+
+```javascript
+greenfinch.track('Registered', {'Gender': 'Male', 'Age': 21});
+```
+
+| Argument | Type | Description |
+| ------------- | ------------- | ----- |
+| **event_name** | <span class="mp-arg-type">String, </span></br></span><span class="mp-arg-required">required</span> | 이벤트 이름 |
+| **properties** | <span class="mp-arg-type">Object, </span></br></span><span class="mp-arg-optional">optional</span> | 추가적으로 전송할 properties |
+
+___
+### greenfinch.page
+pageview event를 전송하는 함수입니다.
+single page application에서 경로 변경 시 호출되는 listener에 추가하시면 됩니다. 
+
+```javascript
+greenfinch.page();
+```
+
+___
+### greenfinch.register
+super properties를 등록하는 함수입니다. 등록 이후 track되는 모든 event에 해당 properties가 추가됩니다. 로그인 성공 직후 유저 정보를 설정하는데 활용 가능합니다. 
+
+```javascript
+greenfinch.register({'user_id': 123456});
+```
+
+
+| Argument | Type | Description |
+| ------------- | ------------- | ----- |
+| **properties** | <span class="mp-arg-type">Object, </span></br></span><span class="mp-arg-required">required</span> | 저장하려고 하는 properties |
+
+___
+### greenfinch.unregister
+super property에 저장되어 있는 항목을 제거하는 함수입니다. 로그아웃 후 유저 정보를 삭제하는데 활용 가능합니다.
+
+```javascript
+greenfinch.unregister('user_id');
+```
+
+
+| Argument | Type | Description |
+| ------------- | ------------- | ----- |
+| **property** | <span class="mp-arg-type">String, </span></br></span><span class="mp-arg-required">required</span> | 삭제하려고 하는 property name |
+
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "Readme.rdoc"
+  rd.rdoc_files.include("Readme.rdoc", "lib/**/*.rb")
+end
+
+task :default => :spec

data/Readme.rdoc

@@ -0,0 +1,109 @@
+{<img src="https://travis-ci.org/mixpanel/mixpanel-ruby.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/mixpanel/mixpanel-ruby]
+
+= mixpanel-ruby: The official Mixpanel Ruby library
+
+mixpanel-ruby is a library for tracking events and sending \Mixpanel profile
+updates to \Mixpanel from your ruby applications.
+
+== Installation
+
+    gem install mixpanel-ruby
+
+== Getting Started
+
+    require 'mixpanel-ruby'
+
+    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
+
+    # Track an event on behalf of user "User1"
+    tracker.track('User1', 'A Mixpanel Event')
+
+    # Send an update to User1's profile
+    tracker.people.set('User1', {
+        '$first_name' => 'David',
+        '$last_name' => 'Bowie',
+        'Best Album' => 'The Rise and Fall of Ziggy Stardust and the Spiders from Mars'
+    })
+
+The primary class you will use to track events is Mixpanel::Tracker. An instance of
+Mixpanel::Tracker is enough to send events directly to \Mixpanel, and get you integrated
+right away.
+
+== Additional Information
+
+For more information please visit:
+
+* Our Ruby API Integration page[https://mixpanel.com/help/reference/ruby#introduction]
+* The usage demo[https://github.com/mixpanel/mixpanel-ruby/tree/master/demo]
+* The documentation[http://mixpanel.github.io/mixpanel-ruby/]
+
+The official Mixpanel gem is built with simplicity and broad applicability in
+mind, but there are also third party Ruby libraries that can work with the library
+to provide useful features in common situations, and support different development
+points of view.
+
+In particular, for Rails apps, the following projects are currently actively maintained:
+
+* MetaEvents[https://github.com/swiftype/meta_events]
+* Mengpaneel[https://github.com/DouweM/mengpaneel]
+
+== Changes
+
+== 2.2.2
+* Add Group Analytics support with Mixpanel::Groups
+
+== 2.2.1
+* Fix buffer clearing on partially successful writes in BufferedConsumer.
+
+== 2.2.0
+* Add Mixpanel::ErrorHandler to simplify custom error handling.
+* Modify Mixpanel::People#fix_property_dates to handle ActiveSupport::TimeWithZone.
+* Increase open and ssl timeouts from 2s to 10s.
+* Fix Doc inconsistancy: always pass token on Mixpanel::tracker.new.
+
+== 2.1.0
+* Add Mixpanel::Tracker#generate_tracking_url, which generates {pixel tracking urls}[https://mixpanel.com/docs/api-documentation/pixel-based-event-tracking].
+* Rescue JSONErrors in the consumer and raise Mixpanel::ServerError in Mixpanel::Consumer#send!.
+* Make it clear how to import events with custom timestamp.
+* Update dependancies in gemspec
+
+== 2.0.1
+* Add Deprecated version of Mixpanel::BufferedConsumer#send
+
+== 2.0.0
+* Raise mixpanel server and connection errors in Mixpanel::Consumer.
+* All public methods in Mixpanel::Event, Mixpanel::People, and subsequently Mixpanel::Tracker
+  rescue Mixpanel errors and return false in the case of an error, return true otherwise
+* Deprecate Mixpanel::Consumer#send, replace with Mixpanel::Consumer#send!
+* Require ruby version minimum of 2.0.0
+
+== 1.4.0
+* Allow unset to unset multiple properties
+
+== 1.3.0
+* Added Consumer#request method, demo with Faraday integration
+
+== 1.2.0
+* All objects with a "strftime" method will be formatted as dates in
+  people updates.
+
+== 1.1.0
+* The default consumer now sends requests (and expects responses) in
+  verbose, JSON mode, which may improve error reporting.
+
+=== 1.0.2
+* Allow ip and optional_params arguments to be accepted by all
+  Mixpanel::People methods (except #destroy_user)
+
+=== 1.0.1
+* Compatibility with earlier versions of ruby. Library development will continue
+  to target 1.9, so later versions may not be compatible with Ruby 1.8, but we
+  love patches!
+
+=== 1.0.0
+* tracker#import added
+* Change to internal tracking message format. Messages written
+  by earlier versions of the library will not work with 1.0.0 consumer classes.
+* alias bugfixed
+* Fixes to tests to allow for different timezones
+* Support for optional/experimental people api properties in people calls