rocketfuel_api 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9256bb60b604f83d1c8b805d6a708498f6204410
-  data.tar.gz: 49f03be88bf6263a5c25fca1a563ea1dd6b21641
+  metadata.gz: 456314a06f38776598e2045296edf49106696152
+  data.tar.gz: 1b09cc1c114efe792eb5651bd773a026653b5c4d
 SHA512:
-  metadata.gz: baf90040ca8b6a8ed70259635a9dc25a7f685cbc71831fe69bf7b80808f37d49934e1f59bb0b8ee687906fa4208b1fffacc3cddb9cac2712c83ca1dec33a0640
-  data.tar.gz: 561d36eacdca2c975407b2935bd878928b16c3266b71d61b80ed8cd0039391e734e9517961ae859d2c895ef5fe6566f8c9560de5f9f623e13663e496cbf288bc
+  metadata.gz: 7532cdeb71ec2ca7caf004ae390cbd1eb5710f2f45192eed8ca0a01f68fa8a470c306cb949a332622dec6cf15036cb92ac65eae3aec0adfbff9d242a68f4c9ea
+  data.tar.gz: 9fb527446be72f94f262e4f4de8389b341e4da28acf0ee21d3510891908201e79c8b810f54601ad0a694fa136472a4636a90364e2d653137d695947257ab4d0c

data/.env

@@ -0,0 +1 @@
+ROCKETFUEL_API_SANDBOX_AUTH_TOKEN: 'rocketfuel-api-sandbox-auth-token'

data/.gitignore

@@ -8,5 +8,7 @@
 /spec/reports/
 /tmp/
 
+.env.test
+
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] (2018-04-05)
+### Added
+- Reporting API (https://api.rocketfuel.com/doc/2016/index.html?raml=%2F2016%2Freports%2Fdoc)
+### Internal
+- Add dotenv gem as development dependency
+
+## [0.1.3] (2017-09-13)
+### Internal
+- Cleanup services and add cache endpoints
+
+## [0.1.2] (2017-09-13)
+### Internal
+- Yaml file for endpoint configuration and other internal changes
+
+## [0.1.0] (2017-09-11)
+### Initial release
+
+[Unreleased]: https://github.com/ad2games/rocketfuel_api/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/ad2games/rocketfuel_api/compare/v0.1.3...v0.2.0
+[0.1.3]: https://github.com/ad2games/rocketfuel_api/compare/v0.1.2...v0.1.3
+[0.1.2]: https://github.com/ad2games/rocketfuel_api/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/ad2games/rocketfuel_api/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/ad2games/rocketfuel_api/commits/v0.1.0

data/README.md

@@ -28,7 +28,7 @@ connection = RocketfuelApi::Connection.new(
 
 # for production
 connection = RocketfuelApi::Connection.new(
-  uri: 'https://api.rocketfuel.com/2016'
+  uri: 'https://api.rocketfuel.com/2016',
   auth_token: ENV['ROCKETFUEL_API_AUTH_TOKEN']
 )
 
@@ -43,9 +43,12 @@ Note: Only the `Company` Service `GET` requests are tested so far.
 
 ## Development
 
-To be able to run the specs, the env var `ROCKETFUEL_API_SANDBOX_AUTH_TOKEN` is needed.
+Run specs with `bundle exec rspec`.
 
-We run rake rubocop to make sure, everything looks good.
+To recreate or create new VCR episodes, a proper value for env var `ROCKETFUEL_API_SANDBOX_AUTH_TOKEN` is needed.
+We recommend that you set it in `.env.test` file. 
+
+We run `rake rubocop` to make sure, everything looks good.
 
 ## License
 

data/lib/rocketfuel_api/connection.rb

@@ -17,4 +17,8 @@ class RocketfuelApi::Connection
   def get(uri_suffix, params = {})
     @connection.get(uri_suffix, params)
   end
+
+  def post(uri_suffix, params = {})
+    @connection.post(uri_suffix, params)
+  end
 end

data/lib/rocketfuel_api/service.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'yaml'
+
 class RocketfuelApi::Service
   def initialize(connection)
     @connection = connection
@@ -20,11 +22,11 @@ class RocketfuelApi::Service
   end
 
   def uri_suffix
-    @endpoints ||= YAML.load_file(
+    @@endpoints ||= YAML.load_file(
       RocketfuelApi.root.join('lib', 'config', 'endpoints_for_services.yaml')
     )
 
-    endpoint  = @endpoints['service'][name]
+    endpoint = @@endpoints['service'][name]
 
     endpoint || raise(RocketfuelApi::NotImplemented,
       format('No endpoint for service %s available.', name))

data/lib/rocketfuel_api/service/reporting.rb

@@ -1,4 +1,12 @@
 # frozen_string_literal: true
 
 class RocketfuelApi::Service::Reporting < RocketfuelApi::Service
+  def run(params = {})
+    params = {
+      use_campaign_currency: 'true',
+      use_campaign_time_zone: 'true'
+    }.merge(params)
+    response = @connection.post(uri_suffix, params)
+    parse_response(response.body)
+  end
 end

data/lib/rocketfuel_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RocketfuelApi
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/rocketfuel_api.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'dotenv'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocketfuel_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Stefan Greffenius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: Rocketfuel API Client.
 email:
 - stefan.greffenius@ad2games.com
@@ -116,9 +130,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".env"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -187,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Rocketfuel API Client.