magnum-pi 0.1.0

data/test/unit/test_api.rb

@@ -0,0 +1,92 @@
+require_relative "../test_helper"
+
+module Unit
+  class TestApi < MiniTest::Test
+
+    class SomeAPI
+      extend MagnumPI::API
+    end
+
+    module SomeOtherAPI
+      extend MagnumPI::API
+    end
+
+    describe MagnumPI::API do
+      describe "when extending a class" do
+        it "also includes MagnumPI::API::Instance within the class" do
+          assert_equal true, SomeAPI.included_modules.include?(MagnumPI::API::Instance)
+        end
+        it "also includes MagnumPI::API::Consumer within the class" do
+          assert_equal true, SomeAPI.included_modules.include?(MagnumPI::API::Consumer)
+        end
+      end
+
+      describe "when extending a module" do
+        it "also extends the module with MagnumPI::API::Consumer" do
+          assert_equal true, (class << SomeOtherAPI; self end).included_modules.include?(MagnumPI::API::Consumer)
+        end
+      end
+
+      describe ".api" do
+        describe "without block argument" do
+          it "returns a MagnumPI::API::Scheme instance" do
+            assert_equal MagnumPI::API::Scheme, SomeAPI.api.class
+          end
+        end
+        describe "with block argument" do
+          it "instance evaluates the passed block" do
+            SomeAPI.api do
+              hello "world"
+            end
+            assert_equal "world", SomeAPI.api[:hello]
+          end
+        end
+      end
+
+      describe ".resources" do
+        describe "without block argument" do
+          it "returns a MagnumPI::API::Resources instance" do
+            assert_equal MagnumPI::API::Resources, SomeAPI.resources.class
+          end
+        end
+        describe "with block argument" do
+          it "instance evaluates the passed block" do
+            SomeAPI.resources do
+              foo "bar"
+            end
+            assert_equal ["bar"], SomeAPI.resources[:foo]
+          end
+        end
+      end
+
+      describe ".initialize" do
+        before do
+          SomeAPI.class_eval do
+            @api = nil
+            @resources = nil
+          end
+          SomeAPI.api do
+            uri "http://awesome.com/api/v1"
+            format :json
+            api_key String
+          end
+          SomeAPI.resources do
+            foo "bar"
+          end
+        end
+        it "returns an instance with the finalized api config" do
+          api = SomeAPI.new :api_key => "123456789"
+          assert_equal({
+            :uri => "http://awesome.com/api/v1",
+            :format => :json,
+            :api_key => "123456789"
+          }, api.send(:api))
+          assert_equal({
+            :foo => ["bar"]
+          }, api.send(:resources))
+        end
+      end
+    end
+
+  end
+end

data/test/unit/test_dsl.rb

@@ -0,0 +1,106 @@
+require_relative "../test_helper"
+
+module Unit
+  class TestDSL < MiniTest::Test
+
+    describe MagnumPI::DSL do
+      describe "#initialize" do
+        it "stores passed valid keys" do
+          dsl = MagnumPI::DSL.new "foo", "bar"
+          assert_equal [:foo, :bar], dsl.instance_eval("@valid_keys")
+        end
+
+        it "instance evaluates a passed block" do
+          MagnumPI::DSL.any_instance.expects(:foo).with("bar")
+          MagnumPI::DSL.new do
+            foo "bar"
+          end
+        end
+      end
+
+      before do
+        @dsl = MagnumPI::DSL.new
+      end
+
+      describe "#class" do
+        it "returns MagnumPI::DSL" do
+          assert_equal MagnumPI::DSL, @dsl.class
+        end
+      end
+
+      describe "#_values" do
+        it "is an internal memoized hash" do
+          assert_equal true, @dsl.instance_eval("_values").is_a?(Hash)
+          assert_equal @dsl.instance_eval("_values").object_id, @dsl.instance_eval("_values").object_id
+        end
+      end
+
+      describe "#[]" do
+        it "is delegated to values" do
+          @dsl.instance_eval("_values").expects(:[]).with("foo")
+          @dsl["foo"]
+        end
+      end
+
+      describe "#slice" do
+        it "is delegated to values" do
+          @dsl.instance_eval("_values").expects(:slice).with("foo", "bar")
+          @dsl.slice "foo", "bar"
+        end
+      end
+
+      describe "#inspect" do
+        it "is delegated to values" do
+          @dsl.instance_eval("_values").expects(:inspect)
+          @dsl.inspect
+        end
+      end
+
+      describe "#to_hash" do
+        it "is delegated to values" do
+          @dsl.instance_eval("_values").expects(:to_hash)
+          @dsl.to_hash
+        end
+      end
+
+      describe "#to_s" do
+        it "is delegated to values" do
+          @dsl.instance_eval("_values").expects(:to_s)
+          @dsl.to_s
+        end
+      end
+
+      describe "#method_missing" do
+        it "functions as a setter for its internal hash" do
+          assert_equal({}, @dsl.instance_eval("_values"))
+          @dsl.foo "bar"
+          @dsl.hello do; end
+          assert_equal({:foo => ["bar"], :hello => []}, @dsl.instance_eval("_values"))
+        end
+      end
+    end
+
+    describe "validation" do
+      class DSL < MagnumPI::DSL
+      private
+        def value_error_message(name, value)
+          "BOOM!!"
+        end
+      end
+
+      it "raises an error when using an invalid key" do
+        dsl = MagnumPI::DSL.new :foo, "bar"
+        dsl.foo
+        dsl.bar
+        assert_raises ArgumentError do
+          dsl.baz
+        end
+      end
+
+      it "can validate the passed value" do
+        assert_equal "Invalid value for 'foo': [] (BOOM!!)", assert_raises(ArgumentError){ DSL.new.foo }.message
+      end
+    end
+
+  end
+end

data/test/unit/test_magnum-pi.rb

@@ -0,0 +1,29 @@
+require_relative "../test_helper"
+
+module Unit
+  class TestMagnumPI < MiniTest::Test
+
+    class SomeAPI
+      extend MagnumPI
+    end
+
+    describe MagnumPI do
+      it "has the current version" do
+        version = "0.1.0"
+        assert_equal version, MagnumPI::VERSION
+        assert File.read(path "CHANGELOG.rdoc").include?("Version #{version}")
+        assert File.read(path "VERSION").include?(version)
+      end
+
+      describe "when extended" do
+        it "also extends base with MagnumPI::API::Consumer" do
+          def SomeAPI.extended_modules
+            (class << self; self end).included_modules
+          end
+          assert_equal true, SomeAPI.extended_modules.include?(MagnumPI::API)
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: magnum-pi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Engel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create an easy interface to talk with APIs
+email:
+- pm_engel@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.rdoc
+- Gemfile
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/vimeo.rb
+- lib/magnum-pi.rb
+- lib/magnum-pi/api.rb
+- lib/magnum-pi/api/consumer.rb
+- lib/magnum-pi/api/instance.rb
+- lib/magnum-pi/api/resources.rb
+- lib/magnum-pi/api/scheme.rb
+- lib/magnum-pi/dsl.rb
+- lib/magnum-pi/gem_ext.rb
+- lib/magnum-pi/gem_ext/mechanize.rb
+- lib/magnum-pi/gem_ext/mechanize/http.rb
+- lib/magnum-pi/gem_ext/mechanize/http/agent.rb
+- lib/magnum-pi/version.rb
+- magnum-pi.gemspec
+- script/console
+- test/test_helper.rb
+- test/test_helper/coverage.rb
+- test/unit/api/test_consumer.rb
+- test/unit/api/test_instance.rb
+- test/unit/api/test_resources.rb
+- test/unit/api/test_scheme.rb
+- test/unit/test_api.rb
+- test/unit/test_dsl.rb
+- test/unit/test_magnum-pi.rb
+homepage: https://github.com/archan937/magnum-pi
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Create an easy interface to talk with APIs
+test_files:
+- test/test_helper.rb
+- test/test_helper/coverage.rb
+- test/unit/api/test_consumer.rb
+- test/unit/api/test_instance.rb
+- test/unit/api/test_resources.rb
+- test/unit/api/test_scheme.rb
+- test/unit/test_api.rb
+- test/unit/test_dsl.rb
+- test/unit/test_magnum-pi.rb