mashery_rails 0.6.2

data/lib/mashery/rails.rb

@@ -0,0 +1,19 @@
+module Mashery
+  def self.load_rails_config!
+    if File.exists? rails_config
+      load_config! rails_config
+    else
+      raise MissingConfig.new
+    end
+  end
+
+  def self.rails_config
+    Rails.root.join("config", "mashery.yml")
+  end
+
+  class Engine < ::Rails::Engine
+    initializer "load_masheri_config" do
+      Mashery.load_rails_config!
+    end
+  end
+end

data/lib/mashery/rest_client.rb

@@ -0,0 +1,31 @@
+module Mashery
+  class RestClient
+    def build_url(query_params)
+      Query.new(query_params).url
+    end
+
+    def activity(activity_type, service_id, options)
+      if activity_type == "developer_activity"
+        developer_activity(service_id, options)
+      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)
+      response = ::RestClient.get(query.url)
+
+      if query.format == "json" or query.format == "csv"
+        response
+      else
+        raise UnknownFormat.new(query.format)
+      end
+    end
+  end
+end

data/lib/mashery/rest_client/query.rb

@@ -0,0 +1,77 @@
+module Mashery
+  class RestClient
+    class Query
+      def initialize(options)
+        @options  = options
+      end
+
+      def service_id
+        @options[:service_id]
+      end
+
+      def resource
+        @options[:resource]
+      end
+
+      def format
+        @options[:format] || "csv"
+      end
+
+      def limit
+        @options[:limit] || 1000
+      end
+
+      def start_date
+        @options[:start_date].strftime("%Y-%m-%dT00:00:00Z")
+      end
+
+      def end_date
+        @options[:end_date].strftime("%Y-%m-%dT00:00:00Z")
+      end
+
+      def check_params!
+        raise QueryParamMissing.new("resource")   if @options[:resource].blank?
+        raise QueryParamMissing.new("end_date")   if @options[:end_date].blank?
+        raise QueryParamMissing.new("start_date") if @options[:start_date].blank?
+      end
+
+      def check_dates!
+        if @options[:end_date] - @options[:start_date] > 7.days
+          raise InvalidDateRange.new(@options[:start_date], @options[:end_date])
+        end
+      end
+
+      def params
+        check_params!
+        check_dates!
+
+        params = {
+          start_date: start_date,
+          end_date:   end_date,
+          format:     format,
+          limit:      limit,
+          apikey:     config.key,
+          sig:        config.signature
+        }
+      end
+
+      def config
+        Mashery.config
+      end
+
+      def query_params
+        URI.encode_www_form(params).gsub("%3A", ":")
+      end
+
+      def rest_path
+        "/v2/rest/#{config.site_id}/reports/calls/#{resource}/service/#{service_id}"
+      end
+
+      def url
+        uri        = URI::HTTP.build(host: config.host, path: rest_path, query: query_params)
+        uri.scheme = "https"
+        uri.to_s
+      end
+    end
+  end
+end

data/lib/mashery/rpc_client.rb

@@ -0,0 +1,58 @@
+module Mashery
+  class RpcClient
+    def config
+      Mashery.config
+    end
+
+    # Test Mashery API with echo service
+    def echo(value)
+      call_remote('test.echo', value)
+    end
+
+    def query_builder(klass)
+      Mashery::QueryBuilder.new(klass)
+    end
+
+    # Use the Mashery query language to grab data
+    def query(string)
+      call_remote("object.query", params: string)
+    end
+
+    # Create an object
+    def create(type, params)
+      # TODO: Handle params!
+      call_remote [type_name, "create"].join('.')
+    end
+
+    def call_remote(method, opts = {})
+      perform('method' => method, 'params' => Array(opts[:params]), 'id' => 1)
+    end
+
+    def full_url
+      build_url(config.site_id, config.key, config.signature)
+    end
+
+    alias :url :full_url
+
+    protected
+
+    def perform(params)
+      JSON.parse(post!(full_url, params))
+    end
+
+    def post!(full_url, params)
+      ::RestClient.post(full_url, params.to_json, {
+        "Content-Type"   => "application/json",
+        "Accept"         => "text/plain",
+        "Content-Length" => params.size
+      })
+    end
+
+    def build_url(site_id, apikey, signature)
+      query      = URI.encode_www_form(apikey: apikey, sig: signature)
+      uri        = URI::HTTP.build(host: config.host, path: "/v2/json-rpc/#{site_id}", query: query.to_s)
+      uri.scheme = "https"
+      uri.to_s
+    end
+  end
+end

data/lib/mashery/rpc_client/base.rb

@@ -0,0 +1,51 @@
+module Mashery
+  class RpcClient
+    class Base
+      def initialize(attributes)
+        attributes.each do |key, value|
+          send("#{key}=", value)
+        end
+      end
+
+      def self.count
+        default_query.items(1).to_json["result"]["total_items"]
+      end
+
+      def self.all
+        default_query.all
+      end
+
+      def self.items(argument)
+        default_query.items(argument)
+      end
+
+      def self.where(argument)
+        default_query.where(argument)
+      end
+
+      def self.page(argument)
+        default_query.page(argument)
+      end
+
+      def self.find_each(&block)
+        default_query.find_each(&block)
+      end
+
+      def self.standard_query
+        Mashery.rpc.query_builder(self).from(object_type).items(100)
+      end
+
+      def self.default_query
+        standard_query
+      end
+
+      def self.first
+        new(standard_query.items(1).all.items[0])
+      end
+
+      def self.object_type
+        self.name.underscore.split('/').last.pluralize
+      end
+    end
+  end
+end

data/lib/mashery/rpc_client/response.rb

@@ -0,0 +1,79 @@
+module Mashery
+  class RpcClient
+    class Response
+      def initialize(query_builder)
+        @query_builder = query_builder
+        @json          = query_builder.to_json
+      end
+
+      def result
+        @json["result"]
+      end
+
+      def error
+        @json["error"]
+      end
+
+      def items
+        result["items"]
+      end
+
+      def to_objects
+        items.map do |item|
+          @query_builder.reify(item)
+        end
+      end
+
+      def find_each(&block)
+        to_objects.each(&block)
+
+        if next_page?
+          response = next_page!
+          response.find_each(&block)
+        end
+      end
+
+      def error?
+        error.present?
+      end
+
+      def length
+        items.length
+      end
+
+      def more_pages?
+        current_page < total_pages
+      end
+
+      alias :next_page? :more_pages?
+
+      def next_page_number
+        current_page + 1
+      end
+
+      # Can't call Mashery too many times, or they get mad
+      MASHERY_WAIT_TIME = 0.1
+
+      def next_page!
+        sleep(MASHERY_WAIT_TIME)
+        Response.new(@query_builder.page(next_page_number))
+      end
+
+      def total_items
+        result["total_items"]
+      end
+
+      def total_pages
+        result["total_pages"]
+      end
+
+      def current_page
+        result["current_page"]
+      end
+
+      def items_per_page
+        result["items_per_page"]
+      end
+    end
+  end
+end

data/lib/mashery/service.rb

@@ -0,0 +1,9 @@
+module Mashery
+  class Service < RpcClient::Base
+    attr_accessor :service_key, :name, :limits, :created, :updated, :object_type
+
+    def activity(options = {})
+      Mashery.rest.activity("developer_activity", service_key, start_date: 1.day.ago, end_date: 0.days.ago)
+    end
+  end
+end

data/masheri.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name    = "masheri"
+  s.version = File.read("VERSION")
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Farley Knight"]
+  s.date = "2013-09-23"
+  s.email = "farleyknight@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.textile"
+  ]
+
+  s.files = `git ls-files`.split("\n")
+
+  s.homepage = "http://github.com/farleyknight/masheri"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "Rails gem for Mashery. Clean config and includes tests with decent test coverage"
+
+  s.add_dependency(%q<activesupport>, [">= 3.1.0"])
+  s.add_dependency(%q<rest-client>, [">= 0"])
+  s.add_dependency(%q<json>, [">= 0"])
+end

data/mashery_rails.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name                      = "mashery_rails"
+  s.version                   = File.read("VERSION")
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors                   = ["Farley Knight"]
+  s.date                      = "2013-09-23"
+  s.email                     = "farleyknight@gmail.com"
+  s.extra_rdoc_files          = [
+    "LICENSE.txt",
+    "README.md",
+  ]
+
+  s.files                     = `git ls-files`.split("\n")
+
+  s.homepage                  = "http://github.com/farleyknight/mashery_rails"
+  s.licenses                  = ["MIT"]
+  s.require_paths             = ["lib"]
+  s.rubygems_version          = "1.8.25"
+  s.summary                   = "Rails gem for Mashery. Clean config and includes tests with decent test coverage"
+
+  s.add_dependency(%q<activesupport>, [">= 3.1.0"])
+  s.add_dependency(%q<rest-client>, [">= 0"])
+  s.add_dependency(%q<json>, [">= 0"])
+end

data/spec/fixtures/config.no_host.yml

@@ -0,0 +1,4 @@
+---
+site_id: "12345"
+key: "abcde"
+secret: "super_secret"

data/spec/fixtures/config.no_key.yml

@@ -0,0 +1,4 @@
+---
+site_id: "12345"
+secret: "super_secret"
+host: "masheri.example.com"

data/spec/fixtures/config.no_secret.yml

@@ -0,0 +1,4 @@
+---
+site_id: "12345"
+key: "abcde"
+host: "masheri.example.com"

data/spec/fixtures/config.no_site_id.yml

@@ -0,0 +1,4 @@
+---
+key: "abcde"
+secret: "super_secret"
+host: "masheri.example.com"

data/spec/fixtures/config.yml

@@ -0,0 +1,5 @@
+---
+site_id: "12345"
+secret: "super_secret"
+key: "abcde"
+host: "masheri.example.com"

data/spec/fixtures/services.json

@@ -0,0 +1,3 @@
+
+
+stuff

data/spec/mashery/config_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Mashery::Config do
+  it "should raise an error on lack of key" do
+    expect {
+      Mashery::Config.new("spec/fixtures/config.no_key.yml")
+    }.to raise_error(Mashery::ParamMissing, /key/)
+  end
+
+  it "should raise an error on lack of site_id" do
+    expect {
+      Mashery::Config.new("spec/fixtures/config.no_site_id.yml")
+    }.to raise_error(Mashery::ParamMissing, /site_id/)
+  end
+
+  it "should raise an error on lack of secret" do
+    expect {
+      Mashery::Config.new("spec/fixtures/config.no_secret.yml")
+    }.to raise_error(Mashery::ParamMissing, /secret/)
+  end
+
+  it "should raise an error on lack of host" do
+    expect {
+      Mashery::Config.new("spec/fixtures/config.no_host.yml")
+    }.to raise_error(Mashery::ParamMissing, /host/)
+  end
+
+  it "should have site_id, key, secret, host and signature as attributes" do
+    config = Mashery::Config.new("spec/fixtures/config.yml")
+    expect do
+      config.key
+      config.secret
+      config.signature
+      config.host
+      config.site_id
+    end.to_not raise_error
+  end
+end