mashery_rails 0.6.2

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 0
+total_score: 0

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 0

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: your_lib
+namespace: YourLib

data/config/reek.yml

@@ -0,0 +1,103 @@
+---
+Attribute:
+  enabled: true
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 2
+  overrides:
+    initialize:
+      max_params: 3
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 2
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 1
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 3
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 10
+TooManyStatements:
+  enabled: true
+  exclude:
+  - each
+  max_statements: 2
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 0

data/config/rubocop.yml

@@ -0,0 +1,58 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+    - 'Gemfile'
+    - 'Gemfile.devtools'
+  Excludes:
+    - '**/vendor/**'
+    - '**/benchmarks/**'
+
+# Avoid parameter lists longer than five parameters.
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessControl:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Max: 79
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Do not favor modifier if/unless usage when you have a single-line body
+IfUnlessModifier:
+  Enabled: false
+
+# Allow case equality operator (in limited use within the specs)
+CaseEquality:
+  Enabled: false
+
+# Constants do not always have to use SCREAMING_SNAKE_CASE
+ConstantName:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/lib/mashery.rb

@@ -0,0 +1,55 @@
+$LOAD_PATH.unshift File.expand_path("./lib")
+
+require 'active_support/core_ext'
+require 'logger'
+require 'digest/md5'
+require 'restclient'
+
+require 'mashery/exceptions'
+require 'mashery/config'
+
+require 'mashery/rpc_client'
+require 'mashery/rpc_client/base'
+require 'mashery/rpc_client/response'
+
+require 'mashery/rest_client'
+require 'mashery/query_builder'
+require 'mashery/rest_client/query'
+
+
+require 'mashery/member'
+require 'mashery/key'
+require 'mashery/service'
+
+module Mashery
+  @@config = nil
+
+  def self.config
+    raise Mashery::ConfigMissing.new unless @@config.present?
+    @@config
+  end
+
+  def self.config=(other)
+    @@config = other
+  end
+
+  def self.load_config!(yaml_file)
+    Mashery.config = Mashery::Config.new(yaml_file)
+  end
+
+  def self.rpc
+    Mashery::RpcClient.new
+  end
+
+  def self.rest
+    Mashery::RestClient.new
+  end
+
+  def self.activity(activity_type, service_id, options)
+    Mashery.rest.activity(activity_type, service_id, options)
+  end
+end
+
+if defined?(Rails)
+  require 'mashery/rails'
+end

data/lib/mashery/config.rb

@@ -0,0 +1,71 @@
+module Mashery
+  class Config
+    DEFAULT_HOSTS = {
+      test:       'api.sandbox.mashery.com',
+      production: 'api.mashery.com'
+    }
+
+    attr_accessor :config
+
+    def initialize(yaml_file)
+      @config ||= YAML.load_file(yaml_file)
+      check_config!
+    end
+
+    def check_config!
+      if config["site_id"].blank?
+        raise ParamMissing.new("site_id")
+      end
+
+      if config["key"].blank?
+        raise ParamMissing.new("key")
+      end
+
+      if config["secret"].blank?
+        raise ParamMissing.new("secret")
+      end
+
+      find_host!
+    end
+
+    def site_id
+      @site_id ||= config["site_id"]
+    end
+
+    def key
+      @key     ||= config["key"]
+    end
+
+    alias :api_key :key
+
+    def secret
+      @secret  ||= config["secret"]
+    end
+
+    def host
+      @host    ||= find_host!
+    end
+
+    def signature
+      Digest::MD5.hexdigest(key + secret + Time.now.to_f.to_i.to_s)
+    end
+
+    protected
+
+    def find_host!
+      if config["host"].present?
+        config["host"]
+      else
+        if defined?(Rails)
+          if Rails.env.test? || Rails.env.development?
+            DEFAULT_HOSTS[:test]
+          elsif Rails.env.production?
+            DEFAULT_HOSTS[:production]
+          end
+        end
+
+        raise ParamMissing.new("host")
+      end
+    end
+  end
+end

data/lib/mashery/exceptions.rb

@@ -0,0 +1,46 @@
+module Mashery
+  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
+
+      super("Your start_date and end_date are #{days} days apart. Mashery's API does not like date ranges that span longer than 7 days. Please use multiple queries to gather your data.")
+    end
+  end
+
+  class QueryParamMissing < Exception
+    def initialize(param)
+      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.inspect}! Please check your config/masheri.yml"
+    end
+  end
+
+  class ConfigMissing < Exception
+    def initialize
+      super "No configuration has been loaded! Please call Mashery.load_config! with a valid Yaml file."
+    end
+  end
+
+  class MissingConfig < Exception
+    def initialize
+      super("Couldn't find config/mashery.yml! \n" +
+        "Please run `rails g mashery:install` to create one and populate it with the necessary API credentials.")
+    end
+  end
+
+  class UnknownFormat < Exception
+    def initialize(format)
+      super "Unknown format #{format.inspect} for REST API call. Standard formats are CSV and JSON."
+    end
+  end
+end

data/lib/mashery/key.rb

@@ -0,0 +1,7 @@
+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)
+  end
+end

data/lib/mashery/local.rb

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

data/lib/mashery/member.rb

@@ -0,0 +1,8 @@
+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)
+  end
+end

data/lib/mashery/query_builder.rb

@@ -0,0 +1,173 @@
+module Mashery
+  class QueryBuilder
+    def initialize(klass = nil, options = {})
+      @klass      = klass
+      @options    = options
+      @conditions = Where.new
+      @select     = Select.new
+    end
+
+    def select(argument)
+      @select = Select.new(argument)
+      clone
+    end
+
+    def from(argument)
+      @from = From.new(argument)
+      clone
+    end
+
+    def where(argument)
+      @conditions.add argument
+      clone
+    end
+
+    def order(column, order)
+      @order = Order.new(column, order)
+      clone
+    end
+
+    def items(argument)
+      @items = Items.new(argument)
+      clone
+    end
+
+    def page(argument)
+      @page = Page.new(argument)
+      clone
+    end
+
+    def query
+      [@select, @from, @order, @conditions, @page, @items].map(&:to_s).reject {|s|
+        s.blank?
+      }.compact.join(" ").strip
+    end
+
+    def reify(*args)
+      raise NoClassGiven.new if @klass.blank?
+      @klass.new(*args)
+    end
+
+    alias :to_s :query
+
+    def to_json
+      Mashery.rpc.query(query)
+    end
+
+    def all
+      Mashery::RpcClient::Response.new(self)
+    end
+
+    def find_each(&block)
+      Mashery::RpcClient::Response.new(self).find_each(&block)
+    end
+
+    def first
+      Mashery::RpcClient::Response.new(items(1)).to_objects.first
+    end
+
+    protected
+
+    class Select
+      def initialize(argument = nil)
+        @argument = argument
+      end
+
+      def query
+        @argument || "*"
+      end
+
+      def to_s
+        "SELECT #{query}"
+      end
+    end
+
+    class From
+      def initialize(argument)
+        @argument = argument
+      end
+
+      def to_s
+        raise MissingFrom.new if @argument.nil?
+        "FROM #{@argument}"
+      end
+    end
+
+    class Where
+      def initialize(hash = {})
+        @hash = hash
+      end
+
+      def add(hash)
+        @hash.merge!(hash)
+      end
+
+      def to_s
+        if @hash.blank?
+          ""
+        else
+          "WHERE #{compute_relation}"
+        end
+      end
+
+      def compute_relation
+        @hash.map do |key, value|
+          if value.is_a? String
+            "#{key} = '#{value}'"
+          else
+            "#{key} = #{value}"
+          end
+        end.join(" AND ")
+      end
+    end
+
+    # An ASC or DESC modifier may appear after each field in the ORDER BY list.  If no modifer appears, ASC is assumed.
+    # > SELECT * FROM members ORDER BY created DESC
+    class Order
+      def initialize(column, order)
+        @column = column
+        @order  = order
+      end
+
+      def to_s
+        if @column.blank? || @order.blank?
+          ""
+        else
+          "ORDER BY #{@column} #{@desc}"
+        end
+      end
+    end
+
+    # the ITEMS clause can specify an alternative number of records to return per page.
+    # > SELECT * FROM members ITEMS 25
+    class Items
+      def initialize(count)
+        @count = count
+      end
+
+      def to_s
+        if @count.blank?
+          ""
+        else
+          "ITEMS #{@count}"
+        end
+      end
+    end
+
+    # By default the first page is returned.  The PAGE clause allows additional pages to be returned.
+    # > SELECT * FROM members PAGE 5
+    class Page
+      def initialize(page)
+        @page = page
+      end
+
+      def to_s
+        if @page.blank?
+          ""
+        else
+          "PAGE #{@page}"
+        end
+      end
+    end
+  end
+end