any_api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3931bd443ce1a3d9701ea5476ef05918700fd9a7
+  data.tar.gz: 08f14997f3102779b09f0598448f68ba37a58d8e
+SHA512:
+  metadata.gz: 627844734297c3bb080eb0194ec922d24a5001c750752ae3deb88393c5c8e002943a1ae4283e0bbe8997c08ef9c75c1aa0ba3f3c95108a97e4ed4fcb8c09ec3a
+  data.tar.gz: 3065622d9b7829c1281249ac7d8e6e49065b5535b029bc09d3d3351b0b41d93ed1f715c6ca4f0055844cadb1b5490bb5b70a52a7ef56edc2878dbd3d69d3b16e

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/test/fixtures/secrets.yml
+**/.DS_Store
+*.gem
+*.rbc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in any_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 anthony
+
+MIT License
+
+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/README.md

@@ -0,0 +1,67 @@
+# AnyApi is  the worlds smallest API client :-)
+
+Decided to share this thanks to some research I did on APIs. Most of them have a base URL, then API endpoint, API username, a API password and transmits data in form of JSON. Then there are requests and responses. This could be a simple solution to access and work with a big or small APIs.
+
+Please give Ruby's Net::HTTP Library a go. That is the backbone behind this.  Net::HTTP simple, does the job, it is fast and build on top Ruby's IO so straight to the point.
+
+## Installation
+
+
+```ruby
+gem 'any_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install any_api
+
+## Usage
+
+
+If you are going to use this with Rails. Add bellow code your application.rb file, or the application_controller.rb file or as an initialiser file. It would work fine with any other Ruby project.
+
+```ruby
+AnyApi.configure do |config|
+  config.username =  "me@example.com"
+  config.password =  "my-sectret-password"
+  config.api_base_url =  "https://iamfree.com/api/v1"
+  #please dont put a "/" at the end of the api_base_url
+end
+```
+
+Then you can call any API with  
+
+```ruby
+response = AnyApi::Request.new("Get", '/products.json' )
+```
+
+The first parameter is the HTTP method. Secondly it is the url endpoint.
+
+If you want to do Post or Update calls please send parameters with your request
+
+
+```ruby
+my_params = {"year"=>"2014", "country"=>"Australia", "first_name"=>"True", "last_name"=>"Colours"}
+response = AnyApi::Request.new( "Post", '/users/new', my_params)
+```
+
+To parse the response
+
+```ruby
+response.parser_response
+```
+
+Thanks
+
+
+## Contributing
+
+1. Fork it ( https://github.com/iamfree-com/any_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/any_api.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'any_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "any_api"
+  spec.version       = AnyApi::VERSION
+  spec.authors       = ["anthony"]
+  spec.email         = ["anthony@iamfree.com"]
+  spec.summary       = %q{Access any API you like}
+  spec.description   = %q{This is probably the world smallest API client. Give the infomation any API asking for you to access it. Then fill the blanks and you are good to go}
+  spec.homepage      = "https://github.com/iamfree-com/any_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/any_api/configuration.rb

@@ -0,0 +1,25 @@
+module AnyApi
+  class Configuration
+    attr_accessor :username, :password, :api_base_url, :log_level
+
+    def initialize
+      self.username =  nil
+      self.password =  nil
+      self.api_base_url = nil
+      self.log_level = 'info'
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||=  Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+end

data/lib/any_api/version.rb

@@ -0,0 +1,3 @@
+module AnyApi
+  VERSION = "0.0.2"
+end

data/lib/any_api.rb

@@ -0,0 +1,49 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+
+require_relative "any_api/configuration"
+
+module AnyApi
+
+  class Request
+
+    attr_accessor :apiresult
+    HTTPMETHODS = ["Get", "Head", "Post", "Patch", "Put", "Proppatch", "Lock", "Unlock", "Options", "Propfind", "Delete", "Move", "Copy", "Mkcol", "Trace"]
+
+    def initialize(http_method, endpoint, params_hsh = nil)
+
+      uri = URI.parse("#{AnyApi.configuration.api_base_url}/#{endpoint}")
+
+      res = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        # a safe eval as only for internal use to give http method - Get, Put, Post, Delete
+        request = eval "Net::HTTP::#{http_method if HTTPMETHODS.include?(http_method)}.new uri"
+        request.basic_auth(AnyApi.configuration.username, AnyApi.configuration.password)
+        request["Content-Type"] = "application/json"
+        if params_hsh
+          request.body = params_hsh.to_json
+        end
+        http.request request
+      end
+
+      @apiresult = res
+    end
+
+
+    def parser_response
+      case  apiresult
+      when Net::HTTPSuccess
+        JSON.parse  apiresult.body
+      when Net::HTTPUnauthorized
+        {'error' => "#{ apiresult.message}: username and password set and correct?"}
+      when Net::HTTPServerError
+        {'error' => "#{ apiresult.message}: try again later?"}
+      else
+        {'error' =>  "there seems to be an error in the server, please try again"}
+      end
+    end
+  end
+
+
+end

data/test/any_api_test.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), 'test_helper.rb')
+
+class AnyApiTest < Minitest::Test
+
+
+  def test_connection
+     response = AnyApi::Request.new( "Get", '/tickets.json')
+      #p response
+      #p response.apiresult.body
+      p response.parser_response
+      assert_equal  "200", response.apiresult.code
+   end
+
+
+end

data/test/fixtures/secrets_example.yml

@@ -0,0 +1,4 @@
+conf:
+  username: myemail@example.com
+  password: BINQa85IY81rfPa6SiA35IY81re1@IY8
+  api_base_url: https://iamfree.com/api/v1

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require "minitest/autorun"
+require 'net/http'
+require 'uri'
+require 'json'
+require 'yaml'
+
+
+libpath = File.dirname(__FILE__)
+$LOAD_PATH.unshift File.join(libpath, "..", "lib")
+
+require_relative "../lib/any_api"
+
+secretfile = YAML.load_file("#{Dir.pwd}/test/fixtures/secrets.yml")
+
+AnyApi.configure do |config|
+  config.username =  secretfile["conf"]["username"]
+  config.password =  secretfile["conf"]["password"]
+  config.api_base_url =  secretfile["conf"]["api_base_url"]
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: any_api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- anthony
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This is probably the world smallest API client. Give the infomation any
+  API asking for you to access it. Then fill the blanks and you are good to go
+email:
+- anthony@iamfree.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- any_api.gemspec
+- lib/any_api.rb
+- lib/any_api/configuration.rb
+- lib/any_api/version.rb
+- test/any_api_test.rb
+- test/fixtures/secrets_example.yml
+- test/test_helper.rb
+homepage: https://github.com/iamfree-com/any_api
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Access any API you like
+test_files:
+- test/any_api_test.rb
+- test/fixtures/secrets_example.yml
+- test/test_helper.rb