magnum-pi 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmM2YTM5NDM4OTY5OTg1Y2I3N2RhYTEzN2MyMzUzZjg4NTVmNmE2Mg==
+  data.tar.gz: !binary |-
+    YzE4OGIxNzU5ZjAyYjk5ZTBlNGU3NGFkZGM3ZDlkMzJlYmY2YzVhNw==
+SHA512:
+  metadata.gz: !binary |-
+    YjRjMzRlZjEyOTNiZjAyMDA3NzAxMDAzOTIxNWFiY2IwMjQzNDcwZTUwMjQw
+    ODRhMTVlY2UzODU4Yjc5MzhiMTI0NDIxYWVlN2I4MzlhNDBkNTVhZTVjZjJh
+    NGY4YzY2NGYxZjZiMmI3NjEzYzU2ZjQ5ZWU3NmExZWJkMWVlMzk=
+  data.tar.gz: !binary |-
+    OGIyZDcxNzMwYjlkNWEwMzk3MDQ1ODNjNTUyYjE1MDE2OWY4NTQ2MDFlMDU4
+    YTU1MzM5NDY1Nzk1M2Q3MWQyZjRmYWZiOGU2ZDhkZWY1YzRhZTA3ZGE3ODZi
+    NTQxNmEyNDliZmE4MjA3M2ZmMzkyNzdiNzkyNDMyZDRiMDdiY2I=

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+.bundle
+.rvmrc
+Gemfile.lock
+doc
+pkg
+test/coverage

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+= MagnumPI CHANGELOG
+
+== Version 0.1.0 (March 26, 2014)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "magnum-pi", :path => "."
+  gem "pry"
+end
+
+group :test do
+  gem "simplecov", :require => false
+  gem "minitest"
+  gem "mocha"
+end

data/README.rdoc

@@ -0,0 +1,31 @@
+== MagnumPI {<img src="https://secure.travis-ci.org/archan937/magnum-pi.png"/>}[http://travis-ci.org/archan937/magnum-pi] {<img src="https://codeclimate.com/github/archan937/magnum-pi.png"/>}[https://codeclimate.com/github/archan937/magnum-pi]
+
+Create an easy interface to talk with APIs
+
+=== Installation
+
+==== Using Bundler
+
+Add <tt>MagnumPI</tt> in <tt>Gemfile</tt> as a gem dependency:
+
+  gem "magnum-pi"
+
+Run the following in your console to install with Bundler:
+
+  $ bundle install
+
+=== TODO
+
+* Support OAuth using APIs
+
+=== License
+
+Copyright (c) 2014 Paul Engel, released under the MIT license
+
+http://gettopup.com – http://github.com/archan937 – http://twitter.com/archan937 – {pm_engel@icloud.com}[mailto:pm_engel@icloud.com]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |test|
+  test.pattern = "test/**/test_*.rb"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/vimeo.rb

@@ -0,0 +1,43 @@
+require "bundler"
+Bundler.require :default, :development
+
+#
+# Usage:
+#
+#   Vimeo.get "archan937/info"
+#   Vimeo.user_info "archan937"
+#   Vimeo.user_info :user => "archan937"
+#
+#   Vimeo.download "archan937.json", :get, "archan937/info"
+#   Vimeo.user_info ["archan937"], "archan937.json"
+#   Vimeo.user_info({:user => "archan937"}, "archan937.json")
+#
+#   Vimeo.get "channel/ruby/videos"
+#   Vimeo.channel_videos "ruby"
+#   Vimeo.channel_videos ["ruby"], "ruby.json"
+#
+
+module Vimeo
+  extend MagnumPI
+
+  api do
+    uri "http://vimeo.com/api/v2"
+    format :json
+  end
+
+  resources do
+    user_info :get, var(:user), "info"
+    channel_videos :get, "channel", var(:channel), "videos"
+  end
+
+private
+
+  def self.to_url(*args)
+    "#{super}/#{args.join("/")}.#{api[:format]}"
+  end
+
+  def self.to_params(url, *args)
+    args[0].is_a?(Hash) ? args[0].slice(:page) : {}
+  end
+
+end

data/lib/magnum-pi.rb

@@ -0,0 +1,14 @@
+require "mechanize"
+require "oj"
+require "xmlsimple"
+
+require "magnum-pi/gem_ext"
+require "magnum-pi/dsl"
+require "magnum-pi/api"
+require "magnum-pi/version"
+
+module MagnumPI
+  def self.extended(base)
+    base.extend API
+  end
+end

data/lib/magnum-pi/api.rb

@@ -0,0 +1,37 @@
+require "magnum-pi/api/scheme"
+require "magnum-pi/api/resources"
+require "magnum-pi/api/instance"
+require "magnum-pi/api/consumer"
+
+module MagnumPI
+  module API
+
+    def self.extended(base)
+      if base.is_a? Class
+        base.send :include, Instance
+        base.send :include, Consumer
+      else
+        base.extend Consumer
+      end
+    end
+
+    def api(&block)
+      @api ||= Scheme.new
+      if block_given?
+        @api.instance_eval &block
+      else
+        @api
+      end
+    end
+
+    def resources(&block)
+      @resources ||= Resources.new
+      if block_given?
+        @resources.instance_eval &block
+      else
+        @resources
+      end
+    end
+
+  end
+end

data/lib/magnum-pi/api/consumer.rb

@@ -0,0 +1,92 @@
+module MagnumPI
+  module API
+    module Consumer
+      class Error < StandardError; end
+
+      def get(*args)
+        url, params = parse_args *args
+        parse_content request(:get, url, params).content
+      end
+
+      def post(*args)
+        url, params = parse_args *args
+        parse_content request(:post, url, params).content
+      end
+
+      def download(target, method, *args)
+        url, params = parse_args *args
+        File.delete target if File.exists? target
+        request(method, url, params).save_as target
+        true
+      end
+
+      def resource(name, variables = {}, save_as = nil)
+        args = parse_resource_variables(resources[name], variables)
+        args = [:download, save_as].concat args if save_as
+        send *args
+      end
+
+    private
+
+      def method_missing(name, *args)
+        resources[name.to_sym] ? resource(name, *args) : super
+      end
+
+      def request(method, url, params)
+        agent.send method, url, params
+      rescue Mechanize::ResponseCodeError => e
+        raise Error, e.message, e.backtrace
+      end
+
+      def agent
+        @agent ||= begin
+          Mechanize.new.tap do |agent|
+            agent.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            agent.pluggable_parser.default = Mechanize::Download
+          end
+        end
+      end
+
+      def parse_args(*args)
+        url = to_url(*args)
+        [url, to_params(url, *args)]
+      end
+
+      def parse_resource_variables(resource, variables)
+        variables = normalize_resource_variables resource, variables
+        resource.collect do |arg|
+          arg.is_a?(Resources::Variable) ? (variables[arg.name.to_s] || variables[arg.name.to_sym]) : arg
+        end
+      end
+
+      def normalize_resource_variables(resource, variables)
+        if !variables.is_a?(Hash) && (vars = resource.select{|x| x.is_a?(Resources::Variable)}).any?
+          variables = [variables].flatten
+          raise ArgumentError, "Unexpected amount of variables: #{variables.size} (expected: #{vars.size})" unless variables.size == vars.size
+          variables = Hash[vars.collect(&:name).zip(variables)]
+        end
+        variables
+      end
+
+      def to_url(*args)
+        api[:uri]
+      end
+
+      def to_params(url, *args)
+        raise NotImplementedError
+      end
+
+      def parse_content(response)
+        case api[:format].to_s
+        when "json"
+          Oj.load response
+        when "xml"
+          XmlSimple.xml_in response
+        else
+          response
+        end
+      end
+
+    end
+  end
+end

data/lib/magnum-pi/api/instance.rb

@@ -0,0 +1,23 @@
+module MagnumPI
+  module API
+    module Instance
+
+      def initialize(params = {})
+        super()
+        @api = self.class.api.finalize params
+        @resources = self.class.resources.to_hash
+      end
+
+    private
+
+      def api
+        @api
+      end
+
+      def resources
+        @resources
+      end
+
+    end
+  end
+end

data/lib/magnum-pi/api/resources.rb

@@ -0,0 +1,17 @@
+module MagnumPI
+  module API
+    class Resources < DSL
+
+      class Variable
+        attr_accessor :name
+      end
+
+      def var(name)
+        Variable.new.tap do |variable|
+          variable.name = name
+        end
+      end
+
+    end
+  end
+end

data/lib/magnum-pi/api/scheme.rb

@@ -0,0 +1,47 @@
+module MagnumPI
+  module API
+    class Scheme < DSL
+
+      def initialize
+        super
+        uri ::String
+        format ::Symbol
+      end
+
+      def finalize(params = {})
+        @types = (types = _types).dup
+        @values = (values = _values).dup
+        params.each do |name, value|
+          process_value name, [value], nil
+        end
+        to_hash
+      ensure
+        @types = types
+        @values = values
+      end
+
+    private
+
+      def _types
+        @types ||= {}
+      end
+
+      def process_value(name, args, block)
+        is_a_class = (value = args[0]).class == ::Class
+        set_type name, is_a_class ? value : value.class
+        set_value name, value unless is_a_class
+      end
+
+      def set_type(name, type)
+        _types[name] ||= type
+      end
+
+      def value_error_message(name, value)
+        unless value.is_a?(type = _types[name])
+          "expected #{type}"
+        end
+      end
+
+    end
+  end
+end

data/lib/magnum-pi/dsl.rb

@@ -0,0 +1,62 @@
+module MagnumPI
+  class DSL < BasicObject
+
+    def initialize(*valid_keys, &block)
+      @valid_keys = valid_keys.collect &:to_sym
+      instance_eval &block if ::Kernel.block_given?
+    end
+
+    def class
+      (class << self; self end).superclass
+    end
+
+    def [](name)
+      _values[name]
+    end
+
+    def slice(*keys)
+      _values.slice *keys
+    end
+
+    def inspect
+      _values.inspect
+    end
+
+    def to_hash
+      _values.to_hash
+    end
+
+    def to_s
+      _values.to_s
+    end
+
+  private
+
+    def _values
+      @values ||= {}
+    end
+
+    def method_missing(name, *args, &block)
+      process_value name, args, block
+    end
+
+    def process_value(name, value, block)
+      set_value name, value
+    end
+
+    def set_value(name, value)
+      unless @valid_keys.empty? || @valid_keys.include?(name)
+        ::Kernel.raise ::ArgumentError, "Invalid key: '#{name}' (valid: #{@valid_keys.inspect})"
+      end
+      if error_message = value_error_message(name, value)
+        ::Kernel.raise ::ArgumentError, "Invalid value for '#{name}': #{value.inspect} (#{error_message})"
+      end
+      _values[name] = value
+    end
+
+    def value_error_message(name, value)
+      # override this method
+    end
+
+  end
+end