masheri 0.3.5 → 0.3.6

data/lib/masheri.rb

@@ -7,20 +7,16 @@ require 'restclient'
 
 require 'masheri/exceptions'
 require 'masheri/config'
-require 'masheri/query_builder'
-require 'masheri/query_methods'
 
 require 'masheri/rpc_client'
+
 require 'masheri/rest_client'
+require 'masheri/query_builder'
 require 'masheri/rest_client/query'
-
-require 'masheri/api_object_base'
+require 'masheri/rest_client/base'
 
 require 'masheri/member'
 require 'masheri/service'
-require 'masheri/key'
-require 'masheri/role'
-require 'masheri/query'
 
 module Masheri
   @@config = nil
@@ -38,10 +34,6 @@ module Masheri
     Masheri.config = Masheri::Config.new(yaml_file)
   end
 
-  def self.local_config
-    File.expand_path("~/.masheri.yml")
-  end
-
   def self.rpc
     Masheri::RpcClient.new
   end
@@ -57,12 +49,7 @@ end
 
 # TODO: Let config be accepted as command line argument
 # (masheri -C config.yml)
+#
 if defined?(Rails)
   require 'masheri/rails'
-elsif File.exists?(Masheri.local_config)
-  Masheri.load_config! Masheri.local_config
-elsif defined?(RSpec)
-  # Skip testing environment..
-else
-  raise Masheri::MissingConfig.new
 end

data/lib/masheri/exceptions.rb

@@ -1,4 +1,10 @@
 module Masheri
+  class NoClassGiven < Exception
+    def initialize
+      super("Cannot create new instance for query builder because class was not given!")
+    end
+  end
+
   class InvalidDateRange < Exception
     def initialize(start_date, end_date)
       days = ((end_date - start_date) / 1.day).ceil
@@ -9,13 +15,13 @@ module Masheri
 
   class QueryParamMissing < Exception
     def initialize(param)
-      super "Couldn't complete request. The query param #{param} is missing."
+      super "Couldn't complete request. The query param #{param.inspect} is missing."
     end
   end
 
   class ParamMissing < Exception
     def initialize(param)
-      super "Couldn't determine Mashery #{param}! Please check your config/masheri.yml"
+      super "Couldn't determine Mashery #{param.inspect}! Please check your config/masheri.yml"
     end
   end
 
@@ -27,19 +33,14 @@ module Masheri
 
   class MissingConfig < Exception
     def initialize
-      if defined?(Rails)
-        super("Couldn't find config/masheri.yml! \n" +
-              "Please run `rails g masheri:install` to create one and populate it with the necessary API credentials.")
-      else
-        super("Couldn't find ~/.masheri.yml! \n" +
-              "Please run `masheri --init` to create one and populate it with the necessary API credentials.")
-      end
+      super("Couldn't find config/masheri.yml! \n" +
+        "Please run `rails g masheri:install` to create one and populate it with the necessary API credentials.")
     end
   end
 
   class UnknownFormat < Exception
     def initialize(format)
-      super "Unknown format #{format} for REST API call. Standard formats are CSV and JSON."
+      super "Unknown format #{format.inspect} for REST API call. Standard formats are CSV and JSON."
     end
   end
 end

data/lib/masheri/member.rb

@@ -1,27 +1,7 @@
 module Masheri
-  class Member < ApiObjectBase
-    def self.create(username, display_name, email, fields = {})
-      fields ||= {}
-      our_fields = fields.merge('username' => username, 'display_name' => display_name, 'email' => email)
-      super(our_fields)
-    end
-
-    def self.fetch_all
-      Masheri::RpcClient.new.call_remote("object.query", params: "SELECT * FROM members")
-    end
-
-    def self.fetch_by_username(username)
-      Masheri::RpcClient.new.call_remote("member.fetch", params: username)
-    end
-
-    def add_role(role_or_id)
-      role_id = role_or_id.is_a?(Role) ? role_or_id.id : role_or_id
-      Masheri.client.call_remote('member.addRole', {'username' => username}, {'id' => role_id})
-    end
-
-    def remove_role(role_or_id)
-      role_id = role_or_id.is_a?(Role) ? role_or_id.id : role_or_id
-      Masheri.client.call_remote('member.removeRole', {'username' => username}, {'id' => role_id})
+  class Member < RestClient::Base
+    def self.object_type
+      "members"
     end
   end
 end

data/lib/masheri/query_builder.rb

@@ -1,8 +1,6 @@
 module Masheri
   class QueryBuilder
-    attr_accessor :klass
-
-    def initialize(klass, options = {})
+    def initialize(klass = nil, options = {})
       @klass      = klass
       @options    = options
       @conditions = Where.new
@@ -45,6 +43,11 @@ module Masheri
       }.compact.join(" ").strip
     end
 
+    def reify(*args)
+      raise NoClassGiven.new if @klass.blank?
+      @klass.new(*args)
+    end
+
     alias :to_s :query
 
     def to_json

data/lib/masheri/rest_client.rb

@@ -1,17 +1,12 @@
 module Masheri
   class RestClient
-    def config
-      Masheri.config
+    def build_url(query_params)
+      Query.new(query_params).url
     end
 
     def developer_activity_query(service_id, options)
       query_options = {service_id: service_id, resource: "developer_activity"}.merge(options)
-      Masheri::RestClient::Query.new(query_options)
-    end
-
-    def developer_activity_url(service_id, options)
-      query = developer_activity_query(service_id, options)
-      query.url
+      Query.new(query_options)
     end
 
     def developer_activity(service_id, options)

data/lib/masheri/rest_client/base.rb

@@ -0,0 +1,44 @@
+module Masheri
+  class RestClient
+    class Base
+      def initialize(attributes)
+        attributes.each do |key, value|
+          send("#{key}=", value)
+        end
+      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
+        Masheri.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
+    end
+  end
+end
+

data/lib/masheri/rest_client/query.rb

@@ -5,6 +5,14 @@ module Masheri
         @options  = options
       end
 
+      def service_id
+        @options[:service_id]
+      end
+
+      def resource
+        @options[:resource]
+      end
+
       def format
         @options[:format] || "csv"
       end
@@ -22,6 +30,7 @@ module Masheri
       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
@@ -54,20 +63,14 @@ module Masheri
         URI.encode_www_form(params).gsub("%3A", ":")
       end
 
-      def service_id
-        @options[:service_id]
-      end
-
-      def resource
-        @options[:resource]
-      end
-
-      def path
+      def rest_path
         "/v2/rest/#{config.site_id}/reports/calls/#{resource}/service/#{service_id}"
       end
 
       def url
-        URI::HTTP.build(host: config.host, path: path, query: query_params).to_s
+        uri        = URI::HTTP.build(host: config.host, path: rest_path, query: query_params)
+        uri.scheme = "https"
+        uri.to_s
       end
     end
   end

data/lib/masheri/rpc_client.rb

@@ -19,12 +19,12 @@ module Masheri
 
     def to_objects
       items.map do |item|
-        @query_builder.klass.new(item)
+        @query_builder.reify(item)
       end
     end
 
     def find_each(&block)
-      items.each(&block)
+      to_objects.each(&block)
 
       if next_page?
         response = next_page!
@@ -104,6 +104,12 @@ module Masheri
       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)
@@ -112,19 +118,17 @@ module Masheri
 
     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 full_url
-      build_url(config.site_id, config.key, config.signature)
+        "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::HTTP.build(host: config.host, path: "/v2/json-rpc/#{site_id}", query: query.to_s).to_s
+      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/masheri/service.rb

@@ -1,8 +1,5 @@
 module Masheri
-  class Service
-    include QueryInstanceMethods
-    extend QueryClassMethods
-
+  class Service < RestClient::Base
     attr_accessor :service_key, :name, :limits, :created, :updated, :object_type
 
     def self.object_type
@@ -13,10 +10,6 @@ module Masheri
       Masheri.rest.developer_activity(service_key, start_date: 1.day.ago, end_date: 0.days.ago)
     end
 
-    def self.show_list
-      find_each do |entry|
-        printf "Service Name: %-50s Service Key: %s\n", entry.name.inspect, entry.service_key
-      end
-    end
+    alias :activity :developer_activity
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: masheri
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-12 00:00:00.000000000 Z
+date: 2013-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -59,6 +59,102 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devtools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 description: 
 email: farleyknight@gmail.com
 executables: []
@@ -69,20 +165,16 @@ extra_rdoc_files:
 - README.textile
 files:
 - lib/masheri.rb
-- lib/masheri/api_object_base.rb
 - lib/masheri/config.rb
 - lib/masheri/exceptions.rb
 - lib/masheri/init.rb
-- lib/masheri/key.rb
 - lib/masheri/local.rb
 - lib/masheri/member.rb
-- lib/masheri/query.rb
 - lib/masheri/query_builder.rb
-- lib/masheri/query_methods.rb
 - lib/masheri/rails.rb
 - lib/masheri/rest_client.rb
+- lib/masheri/rest_client/base.rb
 - lib/masheri/rest_client/query.rb
-- lib/masheri/role.rb
 - lib/masheri/rpc_client.rb
 - lib/masheri/service.rb
 - LICENSE.txt
@@ -103,7 +195,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1386576050914279145
+      hash: 2313416616875261274
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/masheri/api_object_base.rb

@@ -1,28 +0,0 @@
-module Masheri
-  class ApiObjectBase
-    mattr_accessor :type_name
-
-    def self.create(fields = {})
-      # XXX: only send fields that aren't read-only
-      new(Masheri.client.call_remote(method('create'), fields))
-    end
-
-    def self.fetch(id)
-      data = Masheri.rpc.call_remote(method('fetch'), id)
-      data.nil?? nil : new(data)
-    end
-
-    def self.delete(id)
-      Masheri.client.call_remote(method('delete'), id)
-    end
-
-    def self.method(basename)
-      "#{name.split(/\:\:/).last.downcase}.#{basename}"
-    end
-
-    def initialize(data)
-      # XXX: use setter methods
-      data.each_pair {|k, v| instance_variable_set("@#{k}".to_sym, v)}
-    end
-  end
-end

data/lib/masheri/key.rb

@@ -1,22 +0,0 @@
-module Masheri
-  class Key < ApiObjectBase
-    attr_reader :id, :created, :updated, :service_key, :username, :limits
-    attr_accessor(:apikey, :status, :rate_limit_ceiling, :qps_limit_ceiling, :rate_limit_exempt, :qps_limit_exempt,
-                  :required_referer, :secret)
-
-    def self.create(service_key, username, fields = {})
-      fields ||= {}
-      our_fields = fields.merge('service' => {'service_key' => service_key}, 'member' => {'username' => username})
-      super(our_fields)
-    end
-
-    def initialize(data)
-      limits = data.delete('limits')
-      @limits = limits.map {|l| Limit.new(l['period'], l['source'], l['ceiling'])} if limits
-      super
-    end
-  end
-
-  class Limit < Struct.new(:period, :source, :ceiling)
-  end
-end

data/lib/masheri/query.rb

@@ -1,68 +0,0 @@
-#
-# This class handles this aspect of the API:
-#
-# http://support.mashery.com/docs/read/mashery_api/20/Query_Language
-#
-module Masheri
-  class Query
-    OBJECT_TYPES = ['members', 'keys', 'services', 'roles', 'applications']
-    DEFAULT_QUERIES_PER_SECOND = 2
-
-    attr_reader :object_type, :fields
-    attr_accessor :page
-
-    def initialize(object_type, options={})
-      if !OBJECT_TYPES.include?(object_type)
-        raise "Invalid object type. '#{object_type}' must be in #{OBJECT_TYPES.inspect}"
-      end
-
-      @object_type = object_type
-
-      if options[:fields]
-        @fields = options[:fields]
-      else
-        @fields = "*"
-      end
-
-      @where = options[:where]
-      @page = options[:page]
-    end
-
-    def page_clause
-      "PAGE #{@page}" if @page
-    end
-
-    def where_clause
-      "WHERE #{@where}" if @where
-    end
-
-    def query_string
-      "SELECT #{fields} FROM #{object_type} #{where_clause} #{page_clause}"
-    end
-
-    def execute
-      Masheri.client.call_remote('object.query', query_string)
-    end
-
-    def items
-      execute['items']
-    end
-
-    # Page through the results. Due heavy use of the API, this method
-    # takes a qps parameter to control how often the API is called.
-    def fetch_all(qps = DEFAULT_QUERIES_PER_SECOND)
-      response = execute
-      items = response['items']
-
-      while response['current_page'] < response['total_pages']
-        self.page = response['current_page'] + 1
-        response = execute
-        items = items + response['items']
-
-        sleep(1.0/DEFAULT_QUERIES_PER_SECOND)
-      end
-
-      return items
-    end
-  end
-end

data/lib/masheri/query_methods.rb

@@ -1,39 +0,0 @@
-module Masheri
-  module QueryInstanceMethods
-    def initialize(attributes)
-      attributes.each do |key, value|
-        send("#{key}=", value)
-      end
-    end
-  end
-
-  module QueryClassMethods
-    def items(argument)
-      default_query.items(argument)
-    end
-
-    def where(argument)
-      default_query.where(argument)
-    end
-
-    def page(argument)
-      default_query.page(argument)
-    end
-
-    def find_each(&block)
-      default_query.find_each(&block)
-    end
-
-    def standard_query
-      Masheri.rpc.query_builder(self).from(object_type).items(100)
-    end
-
-    def default_query
-      standard_query
-    end
-
-    def first
-      Masheri::Service.new standard_query.items(1).all.items[0]
-    end
-  end
-end

data/lib/masheri/role.rb

@@ -1,20 +0,0 @@
-module Masheri
-  class Role < ApiObjectBase
-    attr_reader :id, :created, :updated, :is_assignable, :is_predefined
-    attr_accessor :name, :description
-
-    def assignable?
-      is_assignable == true
-    end
-
-    def predefined?
-      is_predefined == true
-    end
-
-    def self.create(name, fields = {})
-      fields ||= {}
-      our_fields = fields.merge('name' => name)
-      super(our_fields)
-    end
-  end
-end