se-api 0.0.0.beta1 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39c9f55b4b8c90dec1f736ac5c07d1b0b45e0eebd9272eeb90d44077a5be139c
-  data.tar.gz: be515d58d9963644cfd9905c7f6aefe6730a8b4f3afc674bff38ecd80dfdef89
+  metadata.gz: 3317150023e8aea78e2bd546faa25bd8508e0e9585a0f20e42b1423a8d15238c
+  data.tar.gz: bfc88930f0d54ef27443a2bbae29325a80e30c467611cadcc133aad03cfbf75b
 SHA512:
-  metadata.gz: ecaa5d9b19d82802e1f1dcffb22787f434ec7fb11eefb3d2fb4536d7cc839955424e80b90b1d8b02b555493b79eafb14d6b84d9bcc675c630597ead9a377d960
-  data.tar.gz: 60ff0cca0fb7e438abd116287119e9241b6443a07c57f9b6b82c1209a7831b8a9ae31c3bafb31adf108d0634564ac8fd84619a637a81cde1365e0f875b2af503
+  metadata.gz: 8c4419af179dd69d2ca48b327d921d10ad9ec7e451fbc34078b2df7cb08d0be7c58148445ee87cec090a89ec795a3e3c48ccdf1c258f425b32b2d5051ffb0b8f
+  data.tar.gz: 315e6a5b03dc76a94ebdff3cb87a4f6635b045b82394069f890d1f5d01ef5c7b6083c63b4ab43756bedadc257bcceac53e374d803889338355b32a7da220694c

data/README.md

@@ -1,28 +1,46 @@
-# Se::Api
+# SE API
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/se/api`. To experiment with that code, run `bin/console` for an interactive prompt.
+SE API is a ruby gem for interacting with the Stack Exchange API. It was designed with the [SE Realtime Fee](https://stackexchange.com) in mind (specifically interactions through [se-realtime](https://github.com/izwick-schachter/se-realtime)), and therefore it will only work with four route subsets:
 
-TODO: Delete this and the text above, and describe your gem
+- `/users/{ids}`
+- `/posts/{ids}`
+- `/questions/{ids}`
+- `/answers/{ids}`
 
 ## Installation
 
-Add this line to your application's Gemfile:
+While a version of this gem does exist in rubygems, it's recommended to use it from git. The master branch should always work. You can add it to your Gemfile with:
 
 ```ruby
-gem 'se-api'
+gem 'se-api', git: 'https://github.com/izwick-schachter/se-api.git', branch: 'master'
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install se-api
+First, initialize your client. You can omit the api key, but it's strongly recommended that you use one because it increases your request limit drastically. Also, any paramters that you pass on initialization will be passed with any request (but can be overridden later). It is recommended that you set the `site` this way.
 
-## Usage
+```ruby
+require 'se/api'
+
+cli = SE::API::Client.new(ENV['APIKey'], site: 'stackoverflow')
+```
+
+Now that you've initialized the client, you can use the instance methods provided:
+
+> Note: All the routes below pass `**params` directly to the API.
 
-TODO: Write usage instructions here
+- `post(id, **params)`: Gets a post based on the ID passed.
+- `posts(*ids, **params)`: Get posts based on either a semicolon delimited string of ids or an array of ids.
+- `question(id, **params)`: Gets a question based on the ID passed.
+- `questions(*ids, **params)`: Gets questions based on either a semicolon delimited string of ids or an array of ids.
+- `answer(id, **params)`: Gets an answer based on the ID passed.
+- `answers(*ids, **params)`: Gets answers based on either a semicolon delimited string of ids or an array of ids.
+- `user(id, **params)`: Gets a user based on the ID passed.
+- `users(*ids, **params)`: Gets users based on either a semicolon delimited string of ids or an array of ids.
 
 ## Development
 
@@ -32,7 +50,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/se-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/izwick-schachter/se-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +58,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the Se::Api project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/se-api/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Se::Api project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/izwick-schachter/se-api/blob/master/CODE_OF_CONDUCT.md).

data/lib/se/api.rb

@@ -1,12 +1,15 @@
 require "se/api/version"
-require "se/api/types/post"
 require "se/api/types/answer"
 require "se/api/types/question"
+require "se/api/types/comment"
+require "se/api/types/user"
+require "se/api/types/post"
 
 require "net/http"
 require "json"
 require "uri"
 require "time"
+require "logger"
 
 module SE
   module API
@@ -16,7 +19,7 @@ module SE
       attr_reader :quota, :quota_used
       attr_accessor :params
 
-      def initialize(key, **params)
+      def initialize(key = "", log_api_raw: false, log_api_json: false, log_meta: true, **params)
         @key = key
         @params = params.merge({filter: '!*1_).BnZb8pdvWlZpJYNyauMekouxK9-RzUNUrwiB'})
         @quota = nil
@@ -24,45 +27,78 @@ module SE
         @backoff = Time.now
         @logger_raw = Logger.new 'api_raw.log'
         @logger_json = Logger.new 'api_json.log'
+        @logger = Logger.new 'se-api.log'
+        @logger_raw.level = Logger::Severity::UNKNOWN unless log_api_raw
+        @logger_json.level = Logger::Severity::UNKNOWN unless log_api_json
+        @logger.level = Logger::Severity::UNKNOWN unless log_meta
       end
 
-      def posts(ids = "", **params)
-        return if ids == ""
-        json("posts/#{Array(ids).join(';')}", **params).map do |i|
-          Post.new(i)
-        end
+      def posts(*ids, **params)
+        objectify Post, ids, **params
       end
 
-      def questions(ids = "", **params)
-        return if ids == ""
-        json("questions/#{Array(ids).join(';')}", **params).map do |i|
-          Question.new(i)
-        end
+      def post(id, **params)
+        posts(id, **params).first
       end
 
-      def answers(ids = "", **params)
-        return if ids == ""
-        json("answers/#{Array(ids).join(';')}", **params).map do |i|
-          Answer.new(i)
-        end
+      def questions(*ids, **params)
+        objectify Question, ids, **params
+      end
+
+      def question(id, **params)
+        questions(id, **params).first
+      end
+
+      def answers(*ids, **params)
+        objectify Answer, ids, **params
+      end
+
+      def answer(id, **params)
+        answers(id, **params).first
+      end
+
+      def comments(*ids, **params)
+        objectify Comment, ids, **params
+      end
+
+      def comment(id, **params)
+        comments(id, **params).first
+      end
+
+      def users(*ids, **params)
+        objectify User, ids, **params
+      end
+
+      def user(id, **params)
+        users(id, **params).first
       end
 
       private
 
+      def objectify(type, ids = "", uri: nil, **params)
+        return if ids == ""
+        uri = "#{type.to_s.split('::').last.downcase}s" if uri.nil?
+        json("#{uri}/#{Array(ids).join(';')}", **params).map do |i|
+          type.new(i)
+        end
+      end
+
       def json(uri, **params)
+        params = @params.merge(params)
         throw "No site specified" if params[:site].nil?
         backoff_for = @backoff-Time.now
         backoff_for = 0 if backoff_for <= 0
         if backoff_for > 0
-          puts "Backing off for #{backoff_for}"
+          @logger.warn "Backing off for #{backoff_for}"
           sleep backoff_for+2
-          puts "Finished backing off!"
+          @logger.warn "Finished backing off!"
         end
         params = @params.merge(params).merge({key: @key}).map { |k,v| "#{k}=#{v}" }.join('&')
-        puts "Posting to https://api.stackexchange.com/#{API_VERSION}/#{uri}?#{params}"
+        @logger.info "Posting to https://api.stackexchange.com/#{API_VERSION}/#{uri}?#{params}"
         begin
           resp_raw  = Net::HTTP.get_response(URI("https://api.stackexchange.com/#{API_VERSION}/#{uri}?#{params}")).body
         rescue Net::OpenTimeout, SocketError => e
+          @logger.warn "Got timeout on API request (#{e}). Retrying..."
           puts "Got timeout on API request (#{e}). Retrying..."
           sleep 0.3
           retry
@@ -73,7 +109,7 @@ module SE
         @logger_json.info "https://api.stackexchange.com/#{API_VERSION}/#{uri}?#{params} => #{resp}"
         @quota = resp["quota_remaining"]
         @quota_used += 1
-        resp["items"]
+        Array(resp["items"])
       end
     end
   end

data/lib/se/api/types/answer.rb

@@ -1,3 +1,5 @@
+require "se/api/types/post"
+
 module SE
   module API
     class Answer < Post

data/lib/se/api/types/comment.rb

@@ -0,0 +1,30 @@
+require "se/api/types/user"
+
+module SE
+  module API
+    class Comment
+      attr_reader :body, :link, :id, :post_id, :score, :type, :created_at, :author, :body_markdown, :edited, :post_type
+      attr_reader :json
+
+      def initialize(item_json)
+        @json = Hash(item_json)
+        @body = @json["body"]
+        @body_markdown = @json["body_markdown"]
+        @link = @json["link"]
+        @edited = (@json["edited"] == "true")
+        @post_id = @json["post_id"].to_i
+        @post_type = @json["post_type"]
+        @score = @json["score"].to_i
+        @type = @json["post_type"]
+        @id = @json["comment_id"].to_i
+        @created_at = @json["creation_date"]
+        @author = User.new(@json["owner"])
+      end
+
+      alias_method :user, :author
+      alias_method :owner, :author
+      alias_method :comment_id, :id
+      alias_method :creation_date, :created_at
+    end
+  end
+end

data/lib/se/api/types/post.rb

@@ -1,20 +1,29 @@
+require "se/api/types/user"
+
 module SE
   module API
     class Post
-      attr_reader :body, :title, :link, :author, :score, :type, :id, :last_activity_date
+      attr_reader :body, :title, :link, :author, :score, :type, :id, :last_activity_date, :created_at, :updated_at, :last_editor, :comments
       attr_reader :json
 
       def initialize(item_json)
-        @json = item_json
-        @body = item_json["body"]
-        @title = item_json["title"]
-        @link = item_json["link"]
-        @score = item_json["score"].to_i
-        @type = item_json["post_type"]
-        @id = item_json["id"].to_i
-        @last_activity_date = item_json["last_activity_date"]
-        # @author = User.new(item_json["author"])
+        @json = Hash(item_json)
+        @body = @json["body"]
+        @title = @json["title"]
+        @link = @json["link"]
+        @score = @json["score"].to_i
+        @type = @json["post_type"]
+        @last_editor = User.new(@json["last_editor"])
+        @comments = Array(@json["comments"]&.map { |c| Comment.new(c) })
+        @id = (@json["post_id"] || @json["answer_id"] || @json["question_id"]).to_i
+        @updated_at = @json["last_activity_date"]
+        @created_at = @json["creation_date"]
+        @author = User.new(@json["owner"])
       end
+
+      alias_method :last_activity_date, :updated_at
+      alias_method :user, :author
+      alias_method :owner, :author
     end
   end
 end

data/lib/se/api/types/question.rb

@@ -1,3 +1,5 @@
+require "se/api/types/post"
+
 module SE
   module API
     class Question < Post

data/lib/se/api/types/user.rb

@@ -0,0 +1,19 @@
+module SE
+  module API
+    class User
+      attr_reader :json, :accept_rate, :badge_counts, :name, :link, :image, :reputation, :id, :type
+
+      def initialize(item_json)
+        @json = Hash(item_json)
+        @accept_rate = @json["accept_rate"]
+        @badge_counts = @json["badge_counts"]
+        @name = @json["display_name"]
+        @link = @json["link"]
+        @image = @json["profile_image"]
+        @reputation = @json["reputation"]
+        @id = @json["user_id"]
+        @type = @json["user_type"]
+      end
+    end
+  end
+end

data/lib/se/api/version.rb

@@ -1,5 +1,5 @@
 module SE
   module API
-    VERSION = "0.0.0.beta1"
+    VERSION = "0.0.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: se-api
 version: !ruby/object:Gem::Version
-  version: 0.0.0.beta1
+  version: 0.0.1
 platform: ruby
 authors:
 - thesecretmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-25 00:00:00.000000000 Z
+date: 2018-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,8 +70,10 @@ files:
 - bin/setup
 - lib/se/api.rb
 - lib/se/api/types/answer.rb
+- lib/se/api/types/comment.rb
 - lib/se/api/types/post.rb
 - lib/se/api/types/question.rb
+- lib/se/api/types/user.rb
 - lib/se/api/version.rb
 - se-api.gemspec
 homepage: https://github.com/izwick-schachter/se-api
@@ -90,9 +92,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3