mashery_rails 0.6.7 → 0.6.8

data/Gemfile

@@ -3,6 +3,7 @@ source 'http://rubygems.org'
 gem 'activesupport', ">= 3.1.0"
 gem 'rest-client'
 gem 'json'
+gem 'virtus'
 
 group :test do
   gem 'timecop'

data/Gemfile.lock

@@ -170,6 +170,9 @@ GEM
       concord (~> 0.1.1)
       equalizer (~> 0.0.7)
       parser (~> 2.0.0.pre6)
+    virtus (0.5.5)
+      backports (~> 3.3)
+      descendants_tracker (~> 0.0.1)
     yard (0.8.7.1)
     yard-spellcheck (0.1.5)
       ffi-hunspell (~> 0.2)
@@ -210,6 +213,7 @@ DEPENDENCIES
   simplecov (~> 0.7.1)
   terminal-notifier-guard (~> 1.5.3)
   timecop
+  virtus
   yard (~> 0.8.7)
   yard-spellcheck (~> 0.1.5)
   yardstick (~> 0.9.7)!

data/README.md

@@ -1,5 +1,6 @@
 # mashery_rails
 
+[![Gem Version](https://badge.fury.io/rb/mashery_rails.png)](http://badge.fury.io/rb/mashery_rails)
 [![Coverage Status](https://coveralls.io/repos/farleyknight/mashery_rails/badge.png)](https://coveralls.io/r/farleyknight/mashery_rails)
 [![Build Status](https://travis-ci.org/farleyknight/mashery_rails.png?branch=master)](https://travis-ci.org/farleyknight/mashery_rails)
 [![Code Climate](https://codeclimate.com/github/farleyknight/mashery_rails.png)](https://codeclimate.com/github/farleyknight/mashery_rails)
@@ -42,7 +43,12 @@ Note this doesn't distinguish between development, testing, production, etc. If
 
 ## JSON-RPC API
 
-The central data objects are all listed on the [RPC API documentation page](http://support.mashery.com/docs/read/mashery_api/20/API_Objects), and should be supported. However, [fetching objects](http://support.mashery.com/docs/read/mashery_api/20/Fetching_Objects) are the main & typically only supported method for each of these objects. If you feel you want to support more methods, feel free to create a pull request.
+The central data objects are all listed on the
+[RPC API documentation page](http://support.mashery.com/docs/read/mashery_api/20/API_Objects),
+and should be supported. However,
+[fetching objects](http://support.mashery.com/docs/read/mashery_api/20/Fetching_Objects)
+are the main & typically only supported method for each of these objects. If you would like more API methods,
+don't be shy! Create a pull request and it'll probably get merged within a day.
 
 ### `all`
 
@@ -122,4 +128,74 @@ Mashery::Member.page(10)
 
 ## REST API
 
-Mashery's REST API are mostly calls based on service objects.
+Mashery's REST API are pulling statistics about Services. As such, these calls are invoked via the `Service` API object
+
+### `Service#activity`
+
+Maps to the [CallsDeveloperActivityForService](http://support.mashery.com/docs/read/mashery_api/20_reporting/REST_Resources#CallsDeveloperActivityForService)
+call.
+
+```ruby
+service = Mashery::Service.where(key: "my_service_id")
+service.activity #=>
+```
+
+### `Service#errorcodes`
+
+Maps to the [CallsErrorcodesForService](http://support.mashery.com/docs/read/mashery_api/20_reporting/REST_Resources#CallsErrorcodesForService)
+call.
+
+```ruby
+service = Mashery::Service.where(key: "my_service_id")
+service.errorcodes #=>
+```
+
+### `Service#errorcount`
+
+Maps to the [CallsErrorcountByMethodForService](http://support.mashery.com/docs/read/mashery_api/20_reporting/REST_Resources#CallsErrorcountByMethodForService)
+call.
+
+```ruby
+service = Mashery::Service.where(key: "my_service_id")
+service.errorcount #=>
+```
+
+### `Service#latency`
+
+Maps to the [CallsLatencyForService](http://support.mashery.com/docs/read/mashery_api/20_reporting/REST_Resources#CallsLatencyForService)
+call.
+
+```ruby
+service = Mashery::Service.where(key: "my_service_id")
+service.latency #=>
+```
+
+### `Service#latency_by_method`
+
+Maps to the [CallsLatencyByMethodForService](http://support.mashery.com/docs/read/mashery_api/20_reporting/REST_Resources#CallsLatencyByMethodForService)
+call.
+
+```ruby
+service = Mashery::Service.where(key: "my_service_id")
+service.latency_by_method #=>
+```
+
+### `Service#methods`
+
+Maps to the [CallsMethodsForService](http://support.mashery.com/docs/read/mashery_api/20_reporting/REST_Resources#CallsMethodsForService)
+call.
+
+```ruby
+service = Mashery::Service.where(key: "my_service_id")
+service.methods #=>
+```
+
+### `Service#volume_by_hour`
+
+Maps to the [CallsMedianVolumeByHourForService](http://support.mashery.com/docs/read/mashery_api/20_reporting/REST_Resources#CallsMedianVolumeByHourForService)
+call.
+
+```ruby
+service = Mashery::Service.where(key: "my_service_id")
+service.volume_by_hour #=>
+```

data/lib/generators/mashery_install_generator.rb

@@ -0,0 +1,9 @@
+require 'rails/generators'
+
+class MasheryInstallGenerator < Rails::Generators::Base
+  desc "Create mashery.yml config file"
+  def create_initializer_file
+    config = %q{---\nsite_id: '123'\nkey: "abc"\nsecret: "xyz"\nhost: "api.mashery.com"}
+    create_file "config/mashery.yml", config
+  end
+end

data/lib/mashery/key.rb

@@ -1,7 +1,19 @@
 module Mashery
   class Key < RpcClient::Base
-    attr_accessor(:id, :created, :updated, :service_key, :apikey, :username, :status,
-      :rate_limit_ceiling, :qps_limit_ceiling, :rate_limit_exempt, :qps_limit_exempt,
-      :required_referer, :secret, :limits, :object_type)
+    attribute :id,                 Fixnum
+    attribute :created,            DateTime
+    attribute :updated,            DateTime
+    attribute :service_key,        String
+    attribute :apikey,             String
+    attribute :username,           String
+    attribute :status,             String
+    attribute :rate_limit_ceiling, Fixnum
+    attribute :qps_limit_ceiling,  Fixnum
+    attribute :rate_limit_exempt,  Fixnum
+    attribute :qps_limit_exempt,   Fixnum
+    attribute :required_referer,   Fixnum
+    attribute :secret,             Fixnum
+    attribute :object_type,        String
+    attribute :limits,             Array
   end
 end

data/lib/mashery/member.rb

@@ -1,8 +1,28 @@
 module Mashery
   class Member < RpcClient::Base
-    attr_accessor(:created, :updated, :username, :email, :display_name,
-      :uri, :blog, :im, :imsvc, :phone, :company, :address1, :address2,
-      :locality, :region, :postal_code, :country_code, :first_name, :last_name,
-      :registration_ipaddr, :area_status, :external_id, :passwd_new, :object_type)
+    attribute  :username,             String
+    attribute  :created,              DateTime
+    attribute  :updated,              DateTime
+    attribute  :email,                String
+    attribute  :display_name,         String
+    attribute  :url,                  String
+    attribute  :blog,                 String
+    attribute  :im,                   String
+    attribute  :imsvc,                String
+    attribute  :phone,                String
+    attribute  :company,              String
+    attribute  :address1,             String
+    attribute  :address2,             String
+    attribute  :locality,             String
+    attribute  :region,               String
+    attribute  :postal_code,          String
+    attribute  :country_code,         String
+    attribute  :first_name,           String
+    attribute  :last_name,            String
+    attribute  :registration_ipaddr,  String
+    attribute  :area_status,          String
+    attribute  :external_id,          String
+    attribute  :passwd_new,           String
+    attribute  :object_type,          String
   end
 end

data/lib/mashery/rest_client.rb

@@ -4,21 +4,21 @@ module Mashery
       Query.new(query_params).url
     end
 
-    def activity(activity_type, service_id, options)
+    def call(activity_type, service_id, options)
       if activity_type == "developer_activity"
-        developer_activity(service_id, options)
+        query_options = {service_id: service_id, resource: "developer_activity"}.merge(options)
+        query         = Query.new(query_options)
+        perform_query(query)
+      elsif activity_type == "errorcodes"
+        query_options = {service_id: service_id, resource: "errorcodes"}.merge(options)
+        query         = Query.new(query_options)
+        perform_query(query)
       else
         raise "No such activity type!"
       end
     end
 
-    def developer_activity_query(service_id, options)
-      query_options = {service_id: service_id, resource: "developer_activity"}.merge(options)
-      Query.new(query_options)
-    end
-
-    def developer_activity(service_id, options)
-      query    = developer_activity_query(service_id, options)
+    def perform_query(query)
       response = ::RestClient.get(query.url)
 
       if query.format == "json" or query.format == "csv"

data/lib/mashery/rpc_client/base.rb

@@ -1,11 +1,9 @@
+require 'virtus'
+
 module Mashery
   class RpcClient
     class Base
-      def initialize(attributes)
-        attributes.each do |key, value|
-          send("#{key}=", value)
-        end
-      end
+      include Virtus
 
       def self.count
         default_query.items(1).to_json["result"]["total_items"]

data/lib/mashery/service.rb

@@ -1,9 +1,24 @@
 module Mashery
   class Service < RpcClient::Base
-    attr_accessor :service_key, :name, :limits, :created, :updated, :object_type
+    attribute :service_key,  String
+    attribute :name,         String
+    attribute :limits,       Hash
+    attribute :created,      DateTime
+    attribute :updated,      DateTime
+    attribute :object_type,  String
 
     def activity(options = {})
-      Mashery.rest.activity("developer_activity", service_key, start_date: 1.day.ago, end_date: 0.days.ago)
+      Mashery.rest.call("developer_activity", service_key, {
+        # TODO: For API purposes, these values probably shouldn't be hard-coded
+        start_date: 1.day.ago, end_date: 0.days.ago
+      }.merge(options))
+    end
+
+    def errorcodes(options = {})
+      Mashery.rest.call("errorcodes", service_key, {
+        # TODO: For API purposes, these values probably shouldn't be hard-coded
+        start_date: 1.day.ago, end_date: 0.days.ago
+      }.merge(options))
     end
   end
 end

data/lib/mashery/version.rb

@@ -1,3 +1,3 @@
 module Mashery
-  VERSION = "0.6.7"
+  VERSION = "0.6.8"
 end

data/lib/mashery.rb

@@ -50,6 +50,6 @@ module Mashery
   end
 
   def self.activity(activity_type, service_id, options)
-    Mashery.rest.activity(activity_type, service_id, options)
+    Mashery.rest.call(activity_type, service_id, options)
   end
 end

data/lib/mashery_rails/version.rb

@@ -1,3 +1,3 @@
 module Mashery
-  VERSION = "0.6.7"
+  VERSION = "0.6.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mashery_rails
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.8
   prerelease: 
 platform: ruby
 authors:
@@ -86,6 +86,7 @@ files:
 - config/reek.yml
 - config/rubocop.yml
 - config/yardstick.yml
+- lib/generators/mashery_install_generator.rb
 - lib/mashery.rb
 - lib/mashery/config.rb
 - lib/mashery/exceptions.rb
@@ -133,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1487635472478857244
+      hash: -3439431454915658580
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: