fabricio 1.0.0

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.13.5
+addons:
+  code_climate:
+    repo_token: e4de543181c2bc71c778f9112f45e35467bdd3b8ef58ec4621f5b556ff54c141
+after_success:
+  - bundle exec codeclimate-test-reporter

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at e.tolstoy@rambler-co.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rambler Digital Solutions
+
+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,149 @@
+# Fabricio
+
+[![](https://travis-ci.org/etolstoy/fabricio.svg?branch=develop)](https://travis-ci.org/etolstoy/fabricio)
+[![Code Climate](https://codeclimate.com/github/etolstoy/fabricio/badges/gpa.svg)](https://codeclimate.com/github/etolstoy/fabricio)
+[![Test Coverage](https://codeclimate.com/github/etolstoy/fabricio/badges/coverage.svg)](https://codeclimate.com/github/etolstoy/fabricio/coverage)
+
+> pronounce as [f-ah-bree-see-oh]
+
+A simple gem that fetches mobile application statistics from [Fabric.io](http://fabric.io) using its ~~private~~ not publicly opened [API](https://github.com/etolstoy/fabricio/blob/develop/docs/api_reference.md).
+
+There is a possibility that in some point of time it may break. Feel free to [post an issue](https://github.com/etolstoy/fabricio/issues) and we'll fix it ASAP.
+
+## The Story Behind
+
+[Fabric.io](http://fabric.io) is a great tool made for mobile application developers. It provides data about standard and out-of-memory crashes, active users, audience growth and a lot more. Unfortunately the only official way to work with this data is using Fabric.io website. That means - no automation and no integrations with other services. 
+
+We decided to fix this issue.
+
+         | Key Features
+---------|---------------
+🍫 | Hides the complexity of different Fabric.io APIs behind a simple wrapper.
+📚 | Provides data about organization, applications and builds.
+💥 | Shows crash- and out-of-memory- free metrics.
+⏰  | Automatically refreshes session in case of its expiration.
+🛠 | Provides a simple way of adding your adapter for storing session data in a database of your choice.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fabricio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fabricio
+    
+## Quick Start
+
+1. Create a `Fabricio::Client` object and configure it on initialization.
+
+  ```ruby
+  client = Fabricio::Client.new do |config|
+      config.username = 'your_email'
+      config.password = 'your_password'
+  end
+  ```
+  
+2. Use this client to query any data you want.
+
+  ```ruby
+  client.app.all # Returns all applications on your account
+  client.app.get('app_id') # Returns information about specific application
+  client.app.crashfree('app_id', '1478736000', '1481328000' 'all') # Returns application crashfree for a given period of time
+  client.organization.get # Returns information about your organization
+  ```
+  
+3. If you want to check the exact server output for a model, you can call `json` method on it:
+
+  `client.app.get('app_id').json`
+  
+  You can call a method similar to any key in this hash:
+  
+  `client.app.get('app_id').importance_level`
+  
+## Commands
+
+### Organization
+
+#### `client.organization.get`
+
+Obtains information about your organization.
+
+### App
+
+#### `client.app.all`
+
+Obtains the list of all apps.
+
+#### `client.app.get('app_id')`
+
+Obtains a specific app.
+
+#### `client.app.active_now('app_id')`
+
+Obtains the count of active users at the current moment.
+
+#### `client.app.daily_new('app_id', 'start_timestamp', 'end_timestamp')`
+
+Obtains the count of daily new users.
+
+#### `client.app.daily_active('app_id', 'start_timestamp', 'end_timestamp', 'build')`
+
+Obtains the count of daily active users.
+
+#### `client.app.total_sessions('app_id', 'start_timestamp', 'end_timestamp', 'build')`
+
+Obtains the count of sessions.
+
+#### `client.app.crashes('app_id', 'start_timestamp', 'end_timestamp', 'builds')`
+
+Obtains the count of crashes for a number of builds.
+
+#### `client.app.crashfree('app_id', 'start_timestamp', 'end_timestamp', 'build')`
+
+Obtains application crashfree.
+
+> Fabric.io website uses the same calculations. However, mobile app behaves differently and shows another value.
+
+#### `client.app.oomfree('app_id', 'start_timestamp', 'end_timestamp', 'builds')`
+
+Obtains application out-of-memory free for a number of builds.
+
+### Build
+
+#### `client.build.all('app_id')`
+
+Obtains the list of all application builds.
+
+#### `client.build.get('app_id', 'version', 'build_number')`
+
+Obtains a specific build for a specific application.
+
+#### `client.build.top_versions('app_id', 'start_timestamp', 'end_timestamp')`
+
+Obtains an array of top versions for a given application.
+
+## Additional Info
+
+Fabric.io API:
+
+- [cURL requests](https://github.com/etolstoy/fabricio/blob/develop/docs/api_reference.md)
+- [Swagger](https://github.com/etolstoy/fabricio/blob/develop/docs/swagger-api.json)
+
+## Authors
+
+- Egor Tolstoy
+
+Thanks for help in dealing with API to Vadim Smal, Irina Dyagileva and Andrey Smirnov.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fabricio"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/api_reference.md

@@ -0,0 +1,611 @@
+# API
+
+## Requests
+
+### **POST** - /oauth/token
+
+#### CURL
+
+```sh
+curl -X POST "https://fabric.io/oauth/token" \
+    -H "Content-Type: application/json" \
+    --data-raw "$body"
+```
+
+#### Header Parameters
+
+- **Content-Type** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "enum": [
+    "application/json"
+  ],
+  "default": "application/json"
+}
+```
+
+#### Body Parameters
+
+- **body** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "{\"grant_type\":\"password\",\"scope\":\"organizations apps issues features account twitter_client_apps beta software answers\",\"username\":\"email@rambler.ru\",\"password\":\"pa$$word\",\"client_id\":\"your_client_id\",\"client_secret\":\"your_client_secret\"}"
+}
+```
+
+### **GET** - /api/v2/organizations
+
+#### CURL
+
+```sh
+curl -X GET "https://fabric.io/api/v2/organizations" \
+    -H "Authorization: Bearer {access_token}"
+```
+
+#### Header Parameters
+
+- **Authorization** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "Bearer {access_token}"
+}
+```
+
+### **GET** - /api/v2/apps
+
+#### CURL
+
+```sh
+curl -X GET "https://fabric.io/api/v2/apps" \
+    -H "Authorization: Bearer {access_token}"
+```
+
+#### Header Parameters
+
+- **Authorization** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "Bearer {access_token}"
+}
+```
+
+### **GET** - /api/v2/apps/{app_id}
+
+#### CURL
+
+```sh
+curl -X GET "https://fabric.io/api/v2/apps/{app_id}" \
+    -H "Authorization: Bearer {access_token}"
+```
+
+#### Header Parameters
+
+- **Authorization** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "Bearer {access_token}"
+}
+```
+
+### **GET** - /api/v2/organizations/{organization_id}/apps/{app_id}/growth_analytics/active_now.json
+
+#### CURL
+
+```sh
+curl -X GET "https://fabric.io/api/v2/organizations/{organization_id}/apps/{app_id}/growth_analytics/active_now.json\
+?build=all" \
+    -H "Authorization: Bearer {access_token}"
+```
+
+#### Path Parameters
+
+- **ResponseBodyPath** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "{organization_id}"
+}
+```
+
+#### Query Parameters
+
+- **build** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "enum": [
+    "all",
+    "x.x.x (y)"
+  ],
+  "default": "all"
+}
+```
+
+#### Header Parameters
+
+- **Authorization** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "Bearer {access_token}"
+}
+```
+
+### **GET** - /api/v2/organizations/{organization_id}/apps/{app_id}/growth_analytics/daily_new.json
+
+#### CURL
+
+```sh
+curl -X GET "https://fabric.io/api/v2/organizations/{organization_id}/apps/{app_id}/growth_analytics/daily_new.json\
+?start=1478736000&end=1481328000&build=all" \
+    -H "Authorization: Bearer {access_token}"
+```
+
+#### Path Parameters
+
+- **ResponseBodyPath** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "{organization_id}"
+}
+```
+
+#### Query Parameters
+
+- **start** should respect the following schema:
+
+```
+{
+  "type": "timestamp",
+}
+```
+- **end** should respect the following schema:
+
+```
+{
+  "type": "timestamp",
+}
+```
+- **build** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "enum": [
+    "all",
+    "x.x.x (y)"
+  ],
+  "default": "all"
+}
+```
+
+#### Header Parameters
+
+- **Authorization** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "Bearer {access_token}"
+}
+```
+
+### **GET** - /api/v2/organizations/{organization_id}/apps/{app_id}/growth_analytics/daily_active.json
+
+#### CURL
+
+```sh
+curl -X GET "https://fabric.io/api/v2/organizations/{organization_id}/apps/{app_id}/growth_analytics/daily_active.json\
+?start=1478736000&end=1481328000&build=3.0.4%20(71)" \
+    -H "Authorization: Bearer {access_token}"
+```
+
+#### Path Parameters
+
+- **ResponseBodyPath** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "{organization_id}"
+}
+```
+
+#### Query Parameters
+
+- **start** should respect the following schema:
+
+```
+{
+  "type": "timestamp",
+}
+```
+- **end** should respect the following schema:
+
+```
+{
+  "type": "timestamp",
+}
+```
+- **build** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "enum": [
+    "all",
+    "x.x.x (y)"
+  ],
+  "default": "all"
+}
+```
+
+#### Header Parameters
+
+- **Authorization** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "Bearer {access_token}"
+}
+```
+
+### **POST** - /graphql
+
+#### CURL
+
+```sh
+curl -X POST "https://api-dash.fabric.io/graphql" \
+    -H "Authorization: Bearer {access_token}" \
+    -H "Content-Type: application/json" \
+    --data-raw "$body"
+```
+
+#### Header Parameters
+
+- **Authorization** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "Bearer {access_token}"
+}
+```
+- **Content-Type** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "application/json"
+}
+```
+
+#### Body Parameters
+
+- **body** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "{\n  \"query\": \"query AppScalars($app_id:String!,$type:IssueType!) {project(externalId:$app_id) {crashlytics {scalars:scalars(synthesizedBuildVersions:[\\\"x.x.x (y)\\\", \\\"x.x.x (y)\\\"],type:$type,start:1477958400,end:1480411080) {crashes,issues,impactedDevices}}}}\",\n  \"variables\": {\n    \"app_id\": \"{app_id}\",\n    \"type\": \"crash\"\n  }\n}"
+}
+```
+- **synthesizedBuildVersions** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "[\"x.x.x (y)\"]"
+}
+```
+
+- **start** should respect the following schema:
+
+```
+{
+  "type": "timestamp"
+}
+```
+
+- **end** should respect the following schema:
+
+```
+{
+  "type": "timestamp"
+}
+```
+
+### **GET** - /api/v2/organizations/{organization_id}/apps/{app_id}/growth_analytics/total_sessions_scalar.json
+
+#### CURL
+
+```sh
+curl -X GET "https://fabric.io/api/v2/organizations/{organization_id}/apps/{app_id}/growth_analytics/total_sessions_scalar.json\
+?build=all&start=1480636800&end=1480723200" \
+    -H "Authorization: Bearer {access_token}" \
+    -H "Content-Type: text/plain"
+```
+
+#### Path Parameters
+
+- **ResponseBodyPath** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "{organization_id}"
+}
+```
+
+#### Query Parameters
+
+- **build** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "enum": [
+    "all",
+    "x.x.x (y)"
+  ],
+  "default": "all"
+}
+```
+- **start** should respect the following schema:
+
+```
+{
+  "type": "timestamp"
+}
+```
+- **end** should respect the following schema:
+
+```
+{
+  "type": "timestamp"
+}
+```
+
+#### Header Parameters
+
+- **Authorization** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "Bearer {access_token}"
+}
+```
+
+### **POST** - /graphql
+
+#### CURL
+
+```sh
+curl -X POST "https://api-dash.fabric.io/graphql" \
+    -H "Authorization: Bearer {access_token}" \
+    -H "Content-Type: application/json" \
+    --data-raw "$body"
+```
+
+#### Header Parameters
+
+- **Authorization** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "Bearer {access_token}"
+}
+```
+- **Content-Type** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "enum": [
+    "application/json"
+  ],
+  "default": "application/json"
+}
+```
+
+#### Body Parameters
+
+- **body** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "{\n  \"query\": \"query oomCountForDaysForBuild($app_id: String!, $builds: [String!]!, $days: Int!) { project(externalId: $app_id) { crashlytics{ oomCounts(builds: $builds, days: $days){ timeSeries{ allTimeCount } } oomSessionCounts(builds: $builds, days: $days){ timeSeries{ allTimeCount } } } } }\",\n  \"variables\": {\n    \"app_id\": \"{app_id}\",\n    \"days\": 1,\n    \"builds\": [\n      \"3.0.4 (71)\"\n    ]\n  }\n}"
+}
+```
+
+- **builds** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "[\"x.x.x (y)\"]"
+}
+```
+
+- **app_id** should respect the following schema:
+
+```
+{
+  "type": "string"
+}
+```
+
+- **days** should respect the following schema:
+
+```
+{
+  "type": "integer"
+}
+```
+
+### **GET** - /api/v2/organizations/{organization_id}/apps/{app_id}/beta_distribution/releases/{release_id}
+
+#### CURL
+
+```sh
+curl -X GET "https://fabric.io/api/v2/organizations/{organization_id}/apps/{app_id}/beta_distribution/releases/{release_id}" \
+    -H "Authorization: Bearer {access_token}" \
+    -H "Content-Type: text/plain"
+```
+
+#### Path Parameters
+
+- **ResponseBodyPath** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "{organization_id}"
+}
+```
+
+#### Header Parameters
+
+- **Authorization** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "Bearer {access_token}"
+}
+```
+
+### **GET** - /api/v2/organizations/{organization_id}/apps/{app_id}/beta_distribution/releases
+
+#### CURL
+
+```sh
+curl -X GET "https://fabric.io/api/v2/organizations/{organization_id}/apps/{app_id}/beta_distribution/releases\
+?app%5Bdisplay_version%5D=3.0.5&app%5Bbuild_version%5D=75" \
+    -H "Authorization: Bearer {access_token}"
+```
+
+#### Path Parameters
+
+- **ResponseBodyPath** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "{organization_id}"
+}
+```
+
+#### Query Parameters
+
+- **app[display_version]** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "enum": [
+    "x.x.x"
+  ]
+}
+```
+- **app[build_version]** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "enum": [
+    "y"
+  ]
+}
+```
+
+#### Header Parameters
+
+- **Authorization** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "Bearer {access_token}"
+}
+```
+
+### **GET** - /api/v2/organizations/{organization_id}/apps/{app_id}/growth_analytics/top_builds
+
+#### CURL
+
+```sh
+curl -X GET "https://fabric.io/api/v2/organizations/{organization_id}/apps/{app_id}/growth_analytics/top_builds\
+?start=0&app_id={app_id}&end=1481328000" \
+    -H "Authorization: Bearer {access_token}"
+```
+
+#### Path Parameters
+
+- **ResponseBodyPath** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "{organization_id}"
+}
+```
+
+#### Query Parameters
+
+- **app_id** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "{app_id}"
+}
+```
+- **start** should respect the following schema:
+
+```
+{
+  "type": "timestamp"
+}
+```
+- **end** should respect the following schema:
+
+```
+{
+  "type": "timestamp"
+}
+```
+
+#### Header Parameters
+
+- **Authorization** should respect the following schema:
+
+```
+{
+  "type": "string",
+  "default": "Bearer {access_token}"
+}
+```
+
+## References
+
+- [API in Swagger format](swagger-api.json)